From 58b2634c8cf09b4249f9954ec4c8f5f73169d1ee Mon Sep 17 00:00:00 2001 From: Gochim Date: Thu, 17 Oct 2019 16:43:40 +0300 Subject: [PATCH] Merged info from wiki. Improved on readability --- CONTRIBUTING.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a228d616..647a8b3a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,13 +8,19 @@ 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. +> Commands and screens were created on Windows 10. Please, update all the paths according to your OS. + ## Setting up the project manually Clone the repo -`git clone PyfaDEV` +``` +git clone PyfaDEV +``` Create virtual environment -`python -m venv PyfaEnv` +``` +python -m venv PyfaEnv +``` Activate virtual environment @@ -25,13 +31,20 @@ For bash: source /bin/activate > 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` +``` +pip install -r PyfaDEV\requirements.txt +``` +> For some Linux distributions, you may need to install separate wxPython bindings, such as `python-matplotlib-wx` Check that libs from *requirements.txt* are installed -`pip list` +``` +pip list +``` Test that the project is starting properly -`python PyfaDEV\pyfa.py` +``` +python PyfaDEV\pyfa.py +```