From 66e9944cb5f407a0510d0cd401084c42c625be94 Mon Sep 17 00:00:00 2001 From: Gochim Date: Tue, 15 Oct 2019 20:17:48 +0300 Subject: [PATCH] Added "Setting up the project manually" instructions --- CONTRIBUTING.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a5eceb15..3da9f7ba6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,38 @@ # Contribution +## Requirements + +- Python 3.6 +- Git CLI installed +- Python, pip and git are available as commands (add to path if needed) + ## Setting up the project manually -## Setting up the project with PyCharm/IntelliJ \ No newline at end of file +Virtual environment will be created in *PyfaEnv* folder. Project will be cloned and run from the *PyfaDEV* folder. Separate virtual environment will be created so required libraries won't clutter the main python installation. + +Clone the repo +`git clone PyfaDEV` + +Create virtual environment +`python -m venv PyfaEnv` + +Activate virtual environment + +``` +For cmd.exe: PyfaEnv\scripts\activate.bat +For bash: source /bin/activate +``` +> For other OSes check [Python documentation](https://docs.python.org/3/library/venv.html) + +Install requirements for the project from *requirements.txt* +`pip install -r PyfaDEV\requirements.txt` + +Check that libs from *requirements.txt* are installed +`pip list` + +Test that the project is starting properly +`python PyfaDEV\pyfa.py` + + + +## Setting up the project with PyCharm/IntelliJ