Commits

Tim Tomes committed 6c8d40f

added a getting started section.

Comments (0)

Files changed (1)

 = The Recon-ng Framework
 
 * [[#!usage-guide|Usage Guide]]
+** [[#!getting-started|Getting Started]]
 ** [[#!usage-notes|Usage Notes]]
 \\\\
 * [[#!development-guide|Development Guide]]
 ----
 = Usage Guide
 
+=== Getting Started
+
+* Clone the Recon-ng repository to your local system with {{{git clone https://LaNMaSteR53@bitbucket.org/LaNMaSteR53/recon-ng.git}}}. Change into the Recon-ng directory {{{cd recon-ng}}} and launch with {{{./recon-ng.py}}}.
+
+* There is no guaranteed that the included 3rd party libraries will work on all systems and architectures. If load errors are encountered, try downloading, compiling, and replacing the library which is raising exceptions. The libraries are located in the "libs/ folder. There is no need to install 3rd party libraries to the system. The included modules have been tested on OS X Mountain Lion x64 and BackTrack 5 R3 x86. Below are the 3rd party libraries required by default.
+** PyCrypto - https://www.dlitz.net/software/pycrypto/
+** dnspython - http://www.dnspython.org/
+** httplib2 - http://code.google.com/p/httplib2/
+** python-oauth2 - https://github.com/synedra/python-oauth2
+
 === Usage Notes
 
 Below are a few helpful nuggets to get you started on using the Recon-ng framework. While not all features are covered, the following notes will help make sense of a few of the frameworks more helpful and complex features.
 
-* There is no guaranteed that the included 3rd party modules will work on all systems. If load errors are encountered, try downloading, compiling, and replacing the library which is raising exceptions. The libraries are located in the "libs/ folder. There is no need to install the library to the system. The included modules have been tested on OS X Mountain Lion x64 and BackTrack 5 R3 x86. Below are the default required 3rd party libraries.
-** PyCrypto - [[https://www.dlitz.net/software/pycrypto/|https://www.dlitz.net/software/pycrypto/]]
-** dnspython - [[http://www.dnspython.org/|http://www.dnspython.org/]]
-** httplib2 - [[http://code.google.com/p/httplib2/|http://code.google.com/p/httplib2/]]
-** python-oauth2 - [[https://github.com/synedra/python-oauth2|https://github.com/synedra/python-oauth2]]
-
 * After loading a module, the context of the framework changes, and a new set of commands and options are made available to the user. These commands and options are unique to the module. Use the "help" and "options" commands to gain familiarity with the framework and available commands and options at the root and module contexts.
 
 * The "info" command is another helpful way to discover the capabilities of the framework. The "info" command will return detailed information about a specified module. Spend some time exploring modules with the "info" command in order to get a sense for how information flows through the framework.