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

Add datomic-snippets #845

Closed
wants to merge 1 commit into from
Closed

Add datomic-snippets #845

wants to merge 1 commit into from

Conversation

magnars
Copy link
Contributor

@magnars magnars commented Jun 24, 2013

A snippet package for Datomic. http://www.datomic.com/

I've reused the foundation for snippet packages we managed to hobble together last time. :)

@purcell purcell closed this in 4da8ec1 Jun 25, 2013
@purcell
Copy link
Member

purcell commented Jun 25, 2013

I committed a modified version of this recipe which omits the README: we don't bundle non-.info documentation into packages.

Note that you're missing a dependency on the yasnippet package in the 2 .el files: should probably be (yasnippet "0.6.1").

@magnars
Copy link
Contributor Author

magnars commented Jun 25, 2013

Ok, I added the README since the Commentary-section mentions it. I'm so tired of keeping docs in two places.

I'll fix the yasnippet dependency. Thanks!

@purcell
Copy link
Member

purcell commented Jun 25, 2013

Apparently org-readme can be used to generate a github-ready README from the commentary.

In general, I think that the commentary section should contain just a brief package description and post-installation usage instructions, whereas the README should be broader and contain installation instructions and info about the project in general. So I think the 2 are complementary, rather than redundant.

@magnars
Copy link
Contributor Author

magnars commented Jun 25, 2013

Thanks. I'll move in that direction, then. But it does mean that you're not
bundling a full set of docs with the package.

On Tue, Jun 25, 2013 at 12:21 PM, Steve Purcell notifications@github.comwrote:

Apparently org-readme https://github.com/mlf176f2/org-readme can be
used to generate a github-ready README from the commentary.

In general, I think that the commentary section should contain just a
brief package description and post-installation usage instructions, whereas
the README should be broader and contain installation instructions and info
about the project in general. So I think the 2 are complementary, rather
than redundant.


Reply to this email directly or view it on GitHubhttps://github.com//pull/845#issuecomment-19966738
.

@purcell
Copy link
Member

purcell commented Jun 25, 2013

That's fine. Standard Emacs documentation is either commentary or texinfo, so we're explicitly not supporting anything else.

I wonder if there's something out there which converts markdown to texinfo...

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.

None yet

2 participants