diff --git a/Running-from-source.md b/Running-from-source.md index b416b88..2bfd4fa 100644 --- a/Running-from-source.md +++ b/Running-from-source.md @@ -164,13 +164,28 @@ All other dependencies will be handled by `pip` below. Choose one of the following: 1. Using a zip of the latest stable source. Download and extract the - [latest stable source code](https://github.com/EDCD/EDMarketConnector/archive/stable.zip). + [latest stable source code](https://github com/EDCD/EDMarketConnector/archive/stable.zip). + + **NB: Some niche functionality will not work without two files from the + [FDevIDs repository](https://github.com/EDCD/FDevIDs), which are included + in the Windows installer builds.** You specifically need: + 1. [commodity.csv](https://github.com/EDCD/FDevIDs/raw/master/commodity.csv) + 2. [rare_commodity.csv](https://github.com/EDCD/FDevIDs/raw/master/rare_commodity.csv) + + which should be placed in `FDevIDs/` that unzipping the release archive + will have created. + + Without these the "Settings" > "Output" > "Market data in CSV format file" + feature will not work. + 1. OR Clone and checkout the source using git: - 1. `cd ` - 1. `git clone https://github.com/EDCD/EDMarketConnector.git` - 1. `cd EDMarketConnector` - 1. `git checkout stable` + 1. `cd ` + 2. `git clone https://github.com/EDCD/EDMarketConnector.git` + 3. `cd EDMarketConnector` + 4. `git checkout stable` + 5. `git submodule init` # Necessary to populate `FDevIDs/` + 6. `git submodule update --checkout` # Necessary to populate `FDevIDs/` 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