From a6a5afd56e94487c05fe61a277f4f4c376d1c234 Mon Sep 17 00:00:00 2001 From: Athanasius Date: Mon, 27 Jul 2020 18:23:09 +0100 Subject: [PATCH] Use `stable` for running from source. --- Running-from-source.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Running-from-source.md b/Running-from-source.md index 80015ba..0cdc1c8 100644 --- a/Running-from-source.md +++ b/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`).
*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).