Skip to content

Add link to our docs at ReadTheDoc in the README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrtizmo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add link to our docs at ReadTheDoc in the README #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b78b2cf
added link to ReadTheDocs in a new Quick Start section to README.
mrtizmo Apr 29, 2014
e366b60
Merge branch 'master' of github.com:scsich/phagescan into develop
mrtizmo Apr 29, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ The current code allows you to:
* Add new engines/analysis tools by writing a thin Python wrapper (tools can run on Linux or Windows VMs)
* Isolate and monitor your "worker" VMs which actually execute the engines and perform scans (Openstack or EC2)

# Quick Start
The fastest way to get started is to follow the steps in our [Quick Installation Guide](http://phagescan.readthedocs.org/en/latest/topics/installation/index.html) in the [Phagescan docs](http://phagescan.readthedocs.org/en/latest/index.html).

# Discussion
Our mailing list is here:

Expand Down