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

User Guide needs updates #56

Open
GitMensch opened this issue Sep 14, 2017 · 0 comments
Open

User Guide needs updates #56

GitMensch opened this issue Sep 14, 2017 · 0 comments
Assignees

Comments

@GitMensch
Copy link
Collaborator

GitMensch commented Sep 14, 2017

The user guide can be created with doing make in the doc directory.

It compiles manext from Mark Hessling which then extracts documentation from the PDCurses sources and some additional parts from the X11 port.
In the end all docs are merged to one final md file which is the User Guide.

Things to check / handle:

  • ask Mark Hessling if there's a newer version for manext.c (I've send him a note already, will resend it next week to a different mailing address if needed)
  • integrate the SDL2 docs to the Makefile and remove the links during this conversion (I'll do this)
  • maybe: add a Win32a.md and/or Win32.md for things that only need to be considered in these ports (@Bill-Gray your part???)
  • in any case: check if there are some parts missing, at least PDC_version_info should be added (@Bill-Gray your part?!?) note: most of this seems to be done directly in the pdcurses/*.c sources as this is the root where the information is extracted from
  • check to add a TOC, maybe with a program (invoked either during make or once + copied in or directly)
  • maybe: add the files for converting the markup file into a PDF (most of them are auto-generated by sphinx-quickstart and tweaked afterwards [currently only a little bit]), maybe even add an optional make target to produce the files (both latex via sphinx and PDF via pdflatex)
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

No branches or pull requests

2 participants