diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3da9f7ba6..6a228d616 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,12 @@ - Python 3.6 - Git CLI installed -- Python, pip and git are available as commands (add to path if needed) - -## Setting up the project manually +- Python, pip and git are all available as command-line commands (add to path if needed) 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. +## Setting up the project manually + Clone the repo `git clone PyfaDEV` @@ -22,7 +22,7 @@ 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) +> For other OS 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` @@ -36,3 +36,31 @@ Test that the project is starting properly ## Setting up the project with PyCharm/IntelliJ + +Install PyCharm / Other IntelliJ product with Python plugin + +After launching select *Check out from Version Control* -> *GIt* + +![welcome](https://user-images.githubusercontent.com/54093496/66862580-d8edab00-ef99-11e9-94e2-e93d7043e620.png) + +Login to GitHub, paste repo URL and seect the folder to which to clone the project, press *Clone*. + +![Clone](https://user-images.githubusercontent.com/54093496/66862748-38e45180-ef9a-11e9-9f68-4903baf47385.png) + +After process is complete, open *File* -> *Settings* -> *Project* -> *Project Interpreter*. + +![Settings](https://user-images.githubusercontent.com/54093496/66862792-544f5c80-ef9a-11e9-9e0f-f64767f3f1b0.png) + +Press on options and add new virtual environment. + +![venv](https://user-images.githubusercontent.com/54093496/66862833-67622c80-ef9a-11e9-94fa-47cca0158d29.png) + +Open project tree view and double-click on *requirements.txt*. Press *Install requirements*. Install all requirements. + +![Reqs](https://user-images.githubusercontent.com/54093496/66862870-7a74fc80-ef9a-11e9-9b18-e64be42c49b8.png) + +Create new *Run Configuration*. Set correct *Script path* and *Python interpreter*. + +![Run configuraion](https://user-images.githubusercontent.com/54093496/66862970-b4460300-ef9a-11e9-9fb4-20e24759904b.png) + +Test that the project is starting properly. \ No newline at end of file