Skip to content

Commit

Permalink
Docs: Mention Git in the "Optional" section of "Running from Source" (A…
Browse files Browse the repository at this point in the history
…rchipelagoMW#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 <[email protected]>

* Update docs/running from source.md

Co-authored-by: black-sliver <[email protected]>

* Mention PyCharm's git integration

---------

Co-authored-by: black-sliver <[email protected]>
  • Loading branch information
NewSoupVi and black-sliver authored Jun 24, 2023
1 parent 78b9812 commit ec0822c
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/running from source.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit ec0822c

Please sign in to comment.