Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Mention Git in the "Optional" section of "Running from Source" #1880

Merged
merged 5 commits into from
Jun 24, 2023

Conversation

NewSoupVi
Copy link
Member

GIt is required to install the Zilliandomizer package.

Also, this is probably just nice to have.

GIt is required to install the Zilliandomizer package.

Also, this is probably just nice to have.
docs/running from source.md Outdated Show resolved Hide resolved
docs/running from source.md Outdated Show resolved Hide resolved
docs/running from source.md Show resolved Hide resolved
@ThePhar ThePhar added the is: documentation Improvements or additions to documentation. label Jun 23, 2023
@ThePhar
Copy link
Member

ThePhar commented Jun 23, 2023

Is Git actually optional if Zillion Randomizer needs it? What happens if you try to run from source and git isn't found?

@black-sliver
Copy link
Member

black-sliver commented Jun 23, 2023

Is Git actually optional if Zillion Randomizer needs it? What happens if you try to run from source and git isn't found?

It'll spit out an error but still generate as long as there is no Zillion yaml. The annoying part is that it'll retry each time you run any program.

On a side note: When suggesting it's fine to use git+https://..., I did not consider this. I think github also allows direct zip download links for commits, maybe that would've been smarter.

@black-sliver
Copy link
Member

Okay, looked it up and tried it. Using a github archive tarball url does not work with pip:

Make sure you're either building from a fully intact git repository or PyPI tarballs. Most other sources (such as GitHub's tarballs, a git checkout without the .git folder) don't contain the necessary metadata and will not work.

NewSoupVi and others added 3 commits June 24, 2023 12:27
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@black-sliver black-sliver merged commit ec0822c into ArchipelagoMW:main Jun 24, 2023
FlySniper pushed a commit to FlySniper/Archipelago that referenced this pull request Nov 14, 2023
…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 <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>
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
…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 <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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants