ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-22 11:50:28 +03:00
Code Issues Projects Releases Wiki Activity

Use stable for running from source.

Athanasius 2020-07-27 18:23:09 +01:00
parent 15d0205fef
commit a6a5afd56e
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Running-from-source.md

@ -1,7 +1,20 @@
Running from source
===
1. Download and extract the [latest source code](https://github.com/EDCD/EDMarketConnector/archive/main.zip) (or fork and clone if you're comfortable with using `git`).<br/>*NB: Use `main` branch, not `master` branch* (if the latter even still exists).
1. Download and extract the [latest stable source code](https://github.com/EDCD/EDMarketConnector/archive/stable.zip).
As per [Contributing.md](https://github.com/EDCD/EDMarketConnector/blob/main/Contributing.md#git-branch-structure-and-tag-conventions)
`stable` will contain the latest released code, or possibly some extra
commits leading up to the next release. If you're feeling slightly
braver you could download and extract the [main branch source code](https://github.com/EDCD/EDMarketConnector/archive/main.zip)
instead which might contain newer code that we consider stable enough for
the next release.
You can `git clone` the repository instead and use the appropriate
branch that way if you prefer.
*NB: Do not use the `master` branch*, it's almost empty! The name is
deprecated and we use `main` instead.
1. Ensure you have 'pip' or 'pip3' installed, see [Installing pip](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#installing-pip).