Skip to content

Commit 4c88062

Browse files
author
Tod Beardsley
committed
Squashed commit of the following:
commit 7f65954 Author: Tod Beardsley <[email protected]> Date: Mon Dec 1 07:54:53 2014 -0600 Add a pointer to true and correct docs See rapid7#4000. Seems kind of pointless to ship all these bytes when we host everything on GitHub and provide tools to generate docs yourself. commit 01668c8 Author: Tod Beardsley <[email protected]> Date: Mon Dec 1 07:39:11 2014 -0600 Remove old documentation The last significant commit in this directory was a844b5c , which touched a sample browser module. Before that, changes were either ranging across the codebase, or surgical removal of out of date documentation. This all is looking to me like fairly useless historical artifacts. See rapid7#4000 for more discussion.
1 parent 0ab2e99 commit 4c88062

39 files changed

+34
-4109
lines changed

documentation/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Metasploit Developer Documentation
2+
3+
*(last updated December 1, 2014)
4+
5+
Metasploit is actively supported by a community of hundreds of
6+
contributors and thousands of users world-wide. As a result, the
7+
accompanying documentation moves quite quickly.
8+
9+
The best source of documentation on Metasploit development is
10+
https://github.com/rapid7/metasploit-framework/wiki. There are many
11+
treasures there, such as:
12+
13+
* [Evading Antivirus](https://github.com/rapid7/metasploit-framework/wiki/Evading-Anti-Virus)
14+
* [How Payloads Work](https://github.com/rapid7/metasploit-framework/wiki/How-payloads-work)
15+
* [How to use Datastore Options](https://github.com/rapid7/metasploit-framework/wiki/How-to-use-datastore-options)
16+
* [How to write browser exploits with BES](https://github.com/rapid7/metasploit-framework/wiki/How-to-write-a-browser-exploit-using-BrowserExploitServer)
17+
* [How to write a bruteforcer](https://github.com/rapid7/metasploit-framework/wiki/How-to-use-Msf%3A%3AAuxiliary%3A%3AAuthBrute-to-write-a-bruteforcer)
18+
19+
...and many, many more.
20+
21+
## API Documentation
22+
23+
If you are looking for API documentation, you may run `rake yard` to
24+
generate a navigatable view of the comment documentation used throughout
25+
Metasploit, or visit https://rapid7.github.io/metasploit-framework/api
26+
for a recently generated online version.
27+
28+
## Contributing
29+
30+
If you would like to contribute to the documentation effort, please see
31+
http://yardoc.org/ for details on how to write YARD-compatible comments,
32+
and send us a [Pull Request](https://github.com/rapid7/metasploit-framework/pulls)
33+
with your contribution.
34+

documentation/developers_guide.pdf

-448 KB
Binary file not shown.

documentation/gendocs.sh

Lines changed: 0 additions & 1 deletion
This file was deleted.

documentation/metasploit2/README

Lines changed: 0 additions & 5 deletions
This file was deleted.

documentation/metasploit2/exploits.txt

Lines changed: 0 additions & 161 deletions
This file was deleted.

documentation/msfconsole_rc_ruby_example.rc

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)