arcade icon indicating copy to clipboard operation
arcade copied to clipboard

Fix installation docs

Open cspotcode opened this issue 1 year ago • 1 comments

Fix the installation docs section

  • [ ] Update template
    • https://github.com/pythonarcade/template is out-of-date
    • uses requirements.txt instead of pyproject.toml
  • [ ] Deduplicate PyCharm instructions
    • It may be easier for beginners to read a bespoke guide for their OS, but arcade does not have the manpower to maintain it. We have to simplify to avoid bitrot
    • Windows, Mac, and PyCharm pages all duplicate PyCharm/venv instructions
    • Collapse PyCharm docs to a single page
    • Each OS page should focus on installing python and arcade library. Link to PyCharm page

See also:

  • https://github.com/pythonarcade/arcade/issues/1194#issuecomment-1110327008
  • https://github.com/pythonarcade/arcade/issues/1321

cspotcode avatar Aug 13 '23 18:08 cspotcode

There seems to be no link to the template in the docs. Is this mentioned anywhere in the docs so a user would even know about this? Can we make this a larger repo with cookiecutter templates that can be for different game types. Corresponding to the tutorials perhaps? I can create a few of them. I think this would be great for the GameJam scene also.

sabadam32 avatar Mar 04 '24 20:03 sabadam32

There is one link to the template in docs. I will simply just archive the current install instructions. If users need detailed help this can be found in the arcade book instead.

We have not been maintaining this guide so I'm 100% in agreement that a standard install doc is the right path there.

einarf avatar Jul 13 '24 13:07 einarf

The template repo will be deleted. We no longer provide detailed install instructions. Instead we refer to the arcade book

einarf avatar Jul 13 '24 18:07 einarf