diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6a228d616 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contribution + +## Requirements + +- Python 3.6 +- Git CLI installed +- 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` + +Create virtual environment +`python -m venv PyfaEnv` + +Activate virtual environment + +``` +For cmd.exe: PyfaEnv\scripts\activate.bat +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` + +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 + +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 diff --git a/README.md b/README.md index 7f8b911ad..9e097da54 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,7 @@ The latest version along with release notes can always be found on the project's ## Installation Windows and OS X users are supplied self-contained builds of pyfa on the [latest releases](https://github.com/pyfa-org/Pyfa/releases/latest) page. An `.exe` installer is also available for Windows builds. Linux users can run pyfa using their distribution's Python interpreter. There is no official self-contained package for Linux, however, there are a number of third-party packages available through distribution-specific repositories. -#### OS X - +### OS X Apart from the official release, there is also a [Homebrew](http://brew.sh) option for installing pyfa on OS X. Please note this is maintained by a third-party and is not tested by pyfa developers. Simply fire up in terminal: ``` $ brew install Caskroom/cask/pyfa @@ -27,11 +26,8 @@ The following is a list of pyfa packages available for certain distributions. Pl * Arch: https://aur.archlinux.org/packages/pyfa/ * Gentoo: https://github.com/ZeroPointEnergy/gentoo-pyfa-overlay -### Dependencies -If you wish to help with development or simply need to run pyfa through a Python interpreter, the following software is required: - -* Python 3.6 -* Requirements as listed in `requirements.txt` +## Contribution +If you wish to help with development or you need to run pyfa through a Python interpreter, check out [the instructions](https://github.com/pyfa-org/Pyfa/blob/master/CONTRIBUTING.md). ## Bug Reporting The preferred method of reporting bugs is through the project's [GitHub Issues interface](https://github.com/pyfa-org/Pyfa/issues). Alternatively, posting a report in the [pyfa thread](https://forums.eveonline.com/t/27156) on the official EVE Online forums is acceptable. Guidelines for bug reporting can be found on [this wiki page](https://github.com/pyfa-org/Pyfa/wiki/Bug-Reporting).