Skip to content

Changes to move documentation to Info capability#52

Open
DSMasterson wants to merge 2 commits into
pinoaffe:mainfrom
DSMasterson:main
Open

Changes to move documentation to Info capability#52
DSMasterson wants to merge 2 commits into
pinoaffe:mainfrom
DSMasterson:main

Conversation

@DSMasterson

Copy link
Copy Markdown

README.md: deleted
README.org: revamped docs
Makefile: rules for making docs
org-vcard.info: generated Info file (needed for MELPA)
dir: generated directory addition so Info can find org-vcard.info

README.md: deleted
README.org: revamped docs
Makefile: rules for making docs
org-vcard.info: generated Info file (needed for MELPA)
dir: generated directory addition so Info can find org-vcard.info
@DSMasterson

Copy link
Copy Markdown
Author

Note: after adding this change, you'll need to update MELPA to pickup the org-vcard.info and dir file. You can also drop sending the README file to MELPA -- the info file will be the documentation. However, README.org will be used directly by Github like README.md was.

@pinoaffe

Copy link
Copy Markdown
Owner

Hi! Thank you for the PR! I think moving to Org for the readme is a good idea, and had been planning on doing so at some point. Furthermore, while I like the idea of org-vcard documentation being available via Info, I don't like the idea of putting "compilation output" under version control, so I'm of two minds concerning the automatically generated info files

@DSMasterson

Copy link
Copy Markdown
Author

I understand your concern about "compilation output". Normally, I wouldn't do that, but IIRC, MELPA doesn't have the tools for doing the compilation -- it will just pickup the specified files from a designated repo. Therefore, we're stuck.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants