From ec0822c5eba716a22393304e01a1409fb31f51f1 Mon Sep 17 00:00:00 2001 From: NewSoupVi <57900059+NewSoupVi@users.noreply.github.com> Date: Sat, 24 Jun 2023 12:59:14 +0200 Subject: [PATCH] Docs: Mention Git in the "Optional" section of "Running from Source" (#1880) * Docs: Mention Git in the "Optional" section of "Running from Source" GIt is required to install the Zilliandomizer package. Also, this is probably just nice to have. * Remove mention of Zillion so the text doesn't need updating. * Update docs/running from source.md Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> * Update docs/running from source.md Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> * Mention PyCharm's git integration --------- Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> --- docs/running from source.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/running from source.md b/docs/running from source.md index 611ac04e..c0f4bf58 100644 --- a/docs/running from source.md +++ b/docs/running from source.md @@ -69,6 +69,19 @@ It should be dropped as "SNI" into the root folder of the project. Alternatively host.yaml at your SNI folder. +## Optional: Git + +[Git](https://git-scm.com) is required to install some of the packages that Archipelago depends on. +It may be possible to run Archipelago from source without it, at your own risk. + +It is also generally recommended to have Git installed and understand how to use it, especially if you're thinking about contributing. + +You can download the latest release of Git at [The downloads page on the Git website](https://git-scm.com/downloads). + +Beyond that, there are also graphical interfaces for Git that make it more accessible. +For repositories on Github (such as this one), [Github Desktop](https://desktop.github.com) is one such option. +PyCharm has a built-in version control integration that supports Git. + ## Running tests Run `pip install pytest pytest-subtests`, then use your IDE to run tests or run `pytest` from the source folder.