Skip to content

coventryuniversity/EH-H2GH

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hitchhiker's Guide to Ethical Hacking

A Field manual created by students and staff on the Coventry University Ethical Hacking course.

Working On the H2GH

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)

Getting Started

  1. Fork the repository In Github click "Fork" (top right)

  2. Download your Forked repository

$ git clone <url>
  1. Create a Feature Branch
$ git branch <feature>
$ git checkout <feature>

Setup the working environment

  1. Create a new virtualenv http://docs.python-guide.org/en/latest/dev/virtualenvs/
$ virtualenv --no-site-packages env
  1. Enter the virtualenv
$ source env/bin/activate
  1. Install any dependencies
(env)$ pip install sphinx

Building the Documents

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

Submitting Updates

TODO:

Contributors

@djgoldsmith @digehode

About

HitchHikers Guide to Ethical Hacking

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published