Spencer McIntyre 733c014223 Land #19115, read/write registry key SD | 4 months ago | |
---|---|---|
.. | ||
cli | 26dadef4fc Typo fix | 5 years ago |
modules | 733c014223 Land #19115, read/write registry key SD | 4 months ago |
README.md | e5c636f931 Move folder descriptions into README.md files | 1 year ago |
developers_guide.pdf | 61b4500ffd remove svn:executable from various files | 14 years ago |
This folder is primarily used to hold documentation for Metasploit's various modules, as well as the developers guide
at developers_guide.pdf
.
Metasploit is actively supported by a community of hundreds of contributors and thousands of users world-wide. As a result, the accompanying documentation moves quite quickly.
The best source of documentation on Metasploit development is https://docs.metasploit.com/. There are many treasures there, such as:
...and many, many more.
If you are looking for API documentation, you may run rake yard
to
generate a navigable view of the comment documentation used throughout
Metasploit, or visit https://rapid7.github.io/metasploit-framework/api
for a recently generated online version.
If you would like to contribute to the documentation effort, please see http://yardoc.org/ for details on how to write YARD-compatible comments, and send us a Pull Request with your contribution.