James Lee
b7e26db84e
This is all documentation changes -- adds THIRD-PARTY licenses, updates readme to be more like a readme, and moves the old readme to a COPYING file. Note that while this lands pull #388, it skips the Meterpreter changes that were brought in almost certainly by accident. Squashed commit of the following: commit7125509e8bAuthor: James Lee <egypt@metasploit.com> Date: Wed May 23 13:12:45 2012 -0600 Add license info for rkelly and anemone commit14367041c3Author: James Lee <egypt@metasploit.com> Date: Wed May 23 12:49:14 2012 -0600 Add licenses for gemcache stuff to THIRD-PARTY commitc22138cf24Author: James Lee <egypt@metasploit.com> Date: Mon May 14 17:24:14 2012 -0600 Add useful links commit47a9df3d54Author: James Lee <egypt@metasploit.com> Date: Mon May 14 16:41:21 2012 -0600 Add copyright notices commit687567dfe2Author: James Lee <egypt@metasploit.com> Date: Mon May 14 16:28:17 2012 -0600 Give THIRD-PARTY an md extension Should make display on Github nicer commite322676413Author: James Lee <egypt@metasploit.com> Date: Mon May 14 16:22:55 2012 -0600 Break licenses for bundled stuff into THIRD-PARTY commite6463c6e7fAuthor: James Lee <egypt@metasploit.com> Date: Mon May 14 14:06:01 2012 -0600 Move README to COPYING commit8a6a6bb63fAuthor: James Lee <egypt@metasploit.com> Date: Mon May 14 12:53:31 2012 -0600 Better wording. commit5ac46d4f68Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:51:58 2012 -0600 Add a little more explanitory text to Contributing. commit54dab50d98Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:37:09 2012 -0600 Missed one commite23c80f01eAuthor: James Lee <egypt@metasploit.com> Date: Mon May 14 12:36:33 2012 -0600 Better links commit47b944ec65Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:26:12 2012 -0600 Meh, GFM doesn't like my headings commit12a7651e91Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:24:42 2012 -0600 Initial stab at a better README commite3a0d4731bAuthor: James Lee <egypt@metasploit.com> Date: Mon May 14 11:59:41 2012 -0600 LLC -> Inc. commit5b32b4245cAuthor: James Lee <egypt@metasploit.com> Date: Sun May 13 17:50:04 2012 -0600 Whitespace at EOL commite6719f18abAuthor: James Lee <egypt@metasploit.com> Date: Sun May 13 17:48:50 2012 -0600 Only open /dev/null if we need it
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
|
|
Metasploit
|
|
==
|
|
The Metasploit Framework is released under a BSD-style license. See
|
|
COPYING for more details.
|
|
|
|
The latest version of this software is available from http://metasploit.com/
|
|
|
|
Bug tracking and development information can be found at:
|
|
https://dev.metasploit.com/redmine/projects/framework/
|
|
|
|
The public GitHub source repository can be found at:
|
|
https://github.com/rapid7/metasploit-framework
|
|
|
|
Questions and suggestions can be sent to:
|
|
msfdev(at)metasploit.com
|
|
|
|
The framework mailing list is the place to discuss features and ask for help.
|
|
To subscribe, visit the following web page:
|
|
https://mail.metasploit.com/mailman/listinfo/framework
|
|
|
|
The mailing list archives are available from:
|
|
https://mail.metasploit.com/pipermail/framework/
|
|
|
|
Installing
|
|
--
|
|
Generally, you should use the installer which contains all dependencies
|
|
and will get you up and running with a few clicks. See the [Dev
|
|
Environment Setup][wiki-devenv] if you'd like to deal with dependencies
|
|
on your own.
|
|
|
|
Using Metasploit
|
|
--
|
|
Metasploit can do all sorts of things. The first thing you'll want to do
|
|
is start `msfconsole`, but after that, you'll probably be best served by
|
|
reading some of the great tutorials online:
|
|
|
|
* [Metasploit Unleashed][unleashed]
|
|
* [The official Metasploit wiki on Github][wiki-start]
|
|
|
|
Contributing
|
|
--
|
|
See the [Dev Environment Setup][wiki-devenv] guide on github which will
|
|
walk you through the whole process starting from installing all the
|
|
dependencies, to cloning the repository, and finally to submitting a
|
|
pull request.
|
|
|
|
|
|
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Metasploit-Development-Environment "Metasploit Development Environment Setup"
|
|
[wiki-start]: https://github.com/rapid7/metasploit-framework/wiki/ "Metasploit Wiki"
|
|
[wiki-usage]: https://github.com/rapid7/metasploit-framework/wiki/Using-Metasploit "Using Metasploit"
|
|
[unleashed]: http://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
|
|
|
|
|