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.pdf is about twenty years out of date #6

Open
eddieantonio opened this issue Jan 31, 2016 · 3 comments
Open

user-guide.pdf is about twenty years out of date #6

eddieantonio opened this issue Jan 31, 2016 · 3 comments

Comments

@eddieantonio
Copy link
Owner

Need to update this documentation. I contacted Dr. Steven Rice, but unfortunately (read: unsurprisingly—it's been 20 years) they do not have the source for this document.

While we're at it, might as well publish this on readthedocs.org. It boasts automatically producing HTML, PDF, and ebook output!

@amitdo
Copy link

amitdo commented Jan 31, 2016

Another option is using markdown + pandoc.

Copyright © 1996 by the Information Science Research Institute.
All rights reserved. This document may not be reproduced in whole or in part by any
means without permission.

Maybe you can ask Mr. Rice if you can change this to Apache 2.0 or Creative Commons BY-SA 4.0 license?

What about the manpages ? This tool seems useful:
https://github.com/rtomayko/ron

@eddieantonio
Copy link
Owner Author

Yikes! That copyright that I didn't notice is an even bigger issue; I pretty much need to get that PDF out of this repo soon (though because nobody, including Steven Rice, hasn't said anything, we might still be okay for a while). Thanks for point that out!


I didn't know about ronn! I've been using pandoc+markdown successfully for writing man pages, but ronn seems to have some nice little features that are more manual using my approach.

And the reason I wanted to use readthedocs.org is because it's much more automatic than building documentation using pandoc+markdown. You just create docs/, add a GitHub hook and it compiles and publishes the latest version of the documentation automatically. It's really nice!

Plus it supports markdown!

@amitdo
Copy link

amitdo commented Feb 1, 2016

Plus it supports markdown!

I didn't know that.

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

No branches or pull requests

2 participants