A Field manual created by students and staff on the Coventry University Ethical Hacking course.
Below is an quick overview of how to contribute to the guide. Further details can be found in the guide itself (how meta is that)
-
Fork the repository In Github click "Fork" (top right)
-
Download your Forked repository
$ git clone <url>
- Create a Feature Branch
$ git branch <feature>
$ git checkout <feature>
- Create a new virtualenv http://docs.python-guide.org/en/latest/dev/virtualenvs/
$ virtualenv --no-site-packages env
- Enter the virtualenv
$ source env/bin/activate
- Install any dependencies
(env)$ pip install sphinx
The documents can be compiled using the makefile. Several build options exist, but for the moment we will use HTML
(env)$ make html
The output is available in build/html
@djgoldsmith @digehode