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

Add API documentation to README #4

Open
GuiltyDolphin opened this issue Sep 14, 2016 · 1 comment
Open

Add API documentation to README #4

GuiltyDolphin opened this issue Sep 14, 2016 · 1 comment

Comments

@GuiltyDolphin
Copy link
Owner

Need to add information on the following:

  • What a monitor is.
  • What monitor instances are.
  • define-monitor format and conventions.
  • monitor format and conventions.
  • Existing monitors and their use and attributes.
@GuiltyDolphin
Copy link
Owner Author

GuiltyDolphin commented Sep 18, 2016 •
edited
Loading

It might be worth doing an overview in the README, with more comprehensive documentation in a monitor.org file that can compile to texinfo, which would serve as much better documentation and reference within Emacs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GuiltyDolphin