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

Start a TeX manual #503

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

HermannDppes
Copy link
Contributor

Work tracking pull request for the TeX part of #80.

@HermannDppes
Copy link
Contributor Author

This is proving to be quite annoying since the manual is indeed quite out of date and at some points the in-game help, the manual and the actual behaviour are pairwise different. And in the case of #504 I was not even able to guess what the intended behaviour should have been.

Would you be okay with me splitting this up, concentrating on the parts I would like to do and leaving issues for the remaining parts?

Is there someone who will be able to – ideally quickly – answer all the little questions that arise? As I am only familiar with a few select glimpses of the project, that might vastly ease my workload on this issue.

Copy link

@cRaZy-bisCuiT cRaZy-bisCuiT left a comment

Choose a reason for hiding this comment

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

Looks good to me as a starting point. I might add some Infos about Linux topics (running, configuring, building) as well as armhf/arm64 when the related builds are up and running (Debian/Ubuntu, Raspian, Raspian x64).

@basisbit
Copy link
Member

basisbit commented Jun 5, 2020

Might be easier to use the github wiki for documentation instead of a tex file?

@cRaZy-bisCuiT
Copy link

I'm a big LaTeX fan in general, but it might be much more easy to maintain the GitHub Wiki I guess. Not sure if we'd need a PDF anyways, since no one might want to print that out or something.

@HermannDppes
Copy link
Contributor Author

The primary reason I started this as a standalone document as opposed to a wiki or something was that in #80 it read as if that was something you wanted to have. Personally, I'm fine with discontinuing the offline-first approach and focus on a wiki (that might afterwards be wrapped in a PDF if someone wants it, I guess).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants