Adding Infodocs

[DSMasterson]

Readme.md: deleted README.org: replacement for Readme.md org-incoming.info: generated Infodoc from README.org dir: Info directory addition for org-incoming Makefile: 'make' should be all you need

[DSMasterson]

Infodocs are the standard for Emacs. I did a little reformatting of Readme.md to produce README.org. From that, the Makefile can be used to create the .info file (make sure you do 'make' anytime you do a release). Github supports READMEs in Org format, so you don't need the Markdown file anymore (but you can export the .org to .md if you want).

[tinloaf]

Hi @DSMasterson ,

thanks for the contribution. I'll be honest: I've never warmed up to infodocs. I still think it's the correct way to include the documentation for an Emacs package as infodocs - so thank you!

One question though: What's the Makefile for? I'm trying to understand what it does. I guess it installs the infodocs in a way that Emacs' help system finds it, correct? I'm thinking about the line

ORG_DIR1 = -L $(word 1,$(wildcard $(HOME)/.emacs.d/elpa/org-9*))

… this makes the assumption that org is installed via Elpa, right? That's not always the case, I'm for example using straight to install my org. And what's the 9 doing in that path?

[DSMasterson]

Hi,

With respect to the Makefile, its goal is to generate org-incoming.info from README.org. It also generates the 'dir' file. These will just be delivered in the package directory and the package-install will add them to the Info documentation tree (I don't know if you have to do anything with MELPA). README.org should still be usable by Github to replace Readme.md, but you can also generate README.md from README.org if need be. Test the Makefile with "make -n". Run "make" whenever you checkin an update to README.org.

With respect to ORG_DIR1, I made the following assumptions:

1. When using "--batch" you need to load local libraries you need.
2. All local packages are installed in ~/.emacs.d/elpa.
3. The Org package will be version 9 something.
4. The Org package will be in an 'org-9*' directory.
5. If there is no #3, then the following ifeq sets ORG_DIR1 to "".
6. By using Makefile VARs, you can override assumptions by setting the variable on the make command line.

This worked for me, but there may be other ways of doing it.

Problems with what I submitted:

1. Texinfo v7.2 supports images properly -- lower versions might show images as broken links.
2. To avoid an error, I needed to copy README.org to org-incoming.org before running Emacs.

[tinloaf]

Sounds good, thanks for your contribution. :)