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

README is getting a bit unwieldy... #173

Closed
elsiehupp opened this issue Aug 21, 2023 · 6 comments
Closed

README is getting a bit unwieldy... #173

elsiehupp opened this issue Aug 21, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@elsiehupp
Copy link
Member

I mentioned in a recent PR review that I think at some point we should move the more detailed instructions out of the main README and into their own separate files.

What I think might work is each major platform having its own INSTALLATION file and there being a single main USAGE file for aspects that are common to all platforms.

At some point down the line it could make sense to put all this in, like, a readthedocs documentation site using Sphinx, but until then having separate Markdown files to read here on GitHub should work fine.

@robkam robkam added the documentation Improvements or additions to documentation label Sep 8, 2023
@robkam
Copy link
Member

robkam commented Oct 18, 2023

I've split README.md into INSTALLATION.md and USAGE.md and made a draft PR at #204.

@robkam
Copy link
Member

robkam commented Oct 18, 2023

Three options:

  1. Split USAGE.md into DUMPGENERATOR.md, LAUNCHER.md and UPLOADER.md ?
  2. Move LAUNCHER.md and UPLOADER.md sections into PUBLISHING.md ?
  3. For the time being, leave the documentation files as they are, (since PR 204)?

@robkam
Copy link
Member

robkam commented Oct 19, 2023

204 merged - README is now slimmed down.

@ErroneousBosch
Copy link

The Installation instructions aren't good for non-python people. For instance, I had no idea what poetry is and it doesn't come installed by default on Ubuntu 20.04.

@robkam
Copy link
Member

robkam commented Apr 25, 2024

The instructions are intended to be followed as given, even if their meaning isn't fully understood, as explaining them falls outside the project's scope and would make the documentation even more unwieldy.

@robkam
Copy link
Member

robkam commented Jun 6, 2024

The documentation has been sorted out.

@robkam robkam closed this as completed Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants