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

Update projectormake documentation #189

Open
zwetan opened this issue Oct 8, 2020 · 0 comments
Open

Update projectormake documentation #189

zwetan opened this issue Oct 8, 2020 · 0 comments
Labels
projectormake Utility to build projectors

Comments

@zwetan
Copy link
Member

zwetan commented Oct 8, 2020

  • Every command-line tools should have a manual
    eg. we support man pages by default
    see: man - an interface to the system reference manuals

    • if possible, supports other format for man pages
      like .txt, .html, .pdf (support Windows that does not support man by default)
    • if possible online link
  • Support local HTML documentation

    • basic "getting started", general presentation of the tool
    • usage examples etc.
  • Support online HTML documentation

    • each tools should have its own url
      for ex: https://redtamarin.com/tools/projectormake
      or https://projectormake.redtamarin.com
    • if possible each tools should produce code documentation with asdoc
    • other URL could be https://docs.redtamarin.com/projectormake
      TBD (depends of the amount of documentation)
@zwetan zwetan added the projectormake Utility to build projectors label Oct 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
projectormake Utility to build projectors
Projects
None yet
Development

No branches or pull requests

1 participant