famavott / osint-scraper

Social Recon
MIT License
377 stars 79 forks source link

Add clear installation/usage instructions #166

Closed alichtman closed 6 years ago

alichtman commented 6 years ago

On macOS 10.13.4, I had to run this series of commands to get this program to run.

Would you consider adding these to the README in a USAGE section?

virtualenv venv
. venv/bin/activate
pip3 install -r requirements.txt
pip3 install -e .
pserve development.ini
famavott commented 6 years ago

@alichtman I added clarification to set up a virualenv, and also included instructions to use pip install -r requirements.txt if that is the method devs choose to get all dependencies for the repo. Thanks.