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.

Sign up for GitHub

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

Jump to bottom

Documentation #16

Open
10 tasks
uael opened this issue May 18, 2017 · 3 comments
Open
10 tasks

Documentation #16

uael opened this issue May 18, 2017 · 3 comments
Assignees
@uael
Labels
enhancement help wanted

Comments

@uael
Copy link
Owner

uael commented May 18, 2017

  • Install doc
  • Contributing doc
  • Usage doc
  • API doc
    • Doxygen
    • Doxygen to md ?
    • semver docs
    • semver id doc
    • semver comp doc
    • semver range doc
@uael uael self-assigned this May 18, 2017
@marcomaggi
Copy link
Contributor

I am composing documentation in Texinfo format. You can see the source file.

@uael
Copy link
Owner Author

uael commented May 19, 2017

Cool 😸

@marcomaggi
Copy link
Contributor

I have uploaded the first draft of the HTML output from the Texinfo file. It is only a reference; there are no real world examples; there are no introductory usage notes; the CSS file can be better for sure (I suck at web editing).

Here and there the included code samples make use of _fwrite() functions that are only in a test file from my devel branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@uael uael

Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@marcomaggi @uael