Committing Egypt's README updates

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 rapid7#388, it skips the Meterpreter changes that were brought in almost certainly by accident. Squashed commit of the following: commit 7125509 Author: James Lee <egypt@metasploit.com> Date: Wed May 23 13:12:45 2012 -0600 Add license info for rkelly and anemone commit 1436704 Author: James Lee <egypt@metasploit.com> Date: Wed May 23 12:49:14 2012 -0600 Add licenses for gemcache stuff to THIRD-PARTY commit c22138c Author: James Lee <egypt@metasploit.com> Date: Mon May 14 17:24:14 2012 -0600 Add useful links commit 47a9df3 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 16:41:21 2012 -0600 Add copyright notices commit 687567d Author: 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 commit e322676 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 16:22:55 2012 -0600 Break licenses for bundled stuff into THIRD-PARTY commit e6463c6 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 14:06:01 2012 -0600 Move README to COPYING commit 8a6a6bb Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:53:31 2012 -0600 Better wording. commit 5ac46d4 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:51:58 2012 -0600 Add a little more explanitory text to Contributing. commit 54dab50 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:37:09 2012 -0600 Missed one commit e23c80f Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:36:33 2012 -0600 Better links commit 47b944e Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:26:12 2012 -0600 Meh, GFM doesn't like my headings commit 12a7651 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 12:24:42 2012 -0600 Initial stab at a better README commit e3a0d47 Author: James Lee <egypt@metasploit.com> Date: Mon May 14 11:59:41 2012 -0600 LLC -> Inc. commit 5b32b42 Author: James Lee <egypt@metasploit.com> Date: Sun May 13 17:50:04 2012 -0600 Whitespace at EOL commit e6719f1 Author: James Lee <egypt@metasploit.com> Date: Sun May 13 17:48:50 2012 -0600 Only open /dev/null if we need it
gmanfunky · May 30, 2012 · b7e26db · b7e26db
1 parent 1d63cd6
commit b7e26db
Show file tree

Hide file tree

Showing 3 changed files with 1,138 additions and 18 deletions.
diff --git a/README → COPYING b/README → COPYING
@@ -1,4 +1,4 @@
-Copyright (C) 2006-2012, Rapid7 LLC
+Copyright (C) 2006-2012, Rapid7 Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -49,21 +49,5 @@ This license does not apply to the following components:
  - The Zip library located under lib/zip
  - The SSHKey library located under lib/sshkey
 
-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 e-mail archives are available from:
- https://mail.metasploit.com/pipermail/framework/
+Details for the above packages can be found in the THIRD-PARTY file.
 
diff --git a/README.md b/README.md
@@ -0,0 +1,54 @@
+
+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"
+
+