ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-07-14 15:41:09 +03:00
Code Issues Projects Releases Wiki Activity

Running-from-source: Outline how to get FDevIDs files

Athanasius 2023-01-11 11:29:10 +00:00
parent bc9377870c
commit b9a94f1382
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Running-from-source.md

@ -164,13 +164,28 @@ All other dependencies will be handled by `pip` below.
Choose one of the following: Choose one of the following:
1. Using a zip of the latest stable source. Download and extract the 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. OR Clone and checkout the source using git:
1. `cd <directory you want t be the parent of the source>` 1. `cd <directory you want t be the parent of the source>`
1. `git clone https://github.com/EDCD/EDMarketConnector.git` 2. `git clone https://github.com/EDCD/EDMarketConnector.git`
1. `cd EDMarketConnector` 3. `cd EDMarketConnector`
1. `git checkout stable` 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) 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 `stable` will contain the latest released code, or possibly some extra