Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
org-readme tries to integrate a single lisp file library with a Readme.org file
Emacs Lisp

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
Readme.org
org-readme.el

Readme.org

Org Readme

Library Information

org-readme.el — Integrates Readme.org and Commentary/Change-logs.

Filename
org-readme.el
Description
Integrate Readme.org and Commentary/Change Logs.
Author
Matthew L. Fidler
Maintainer
Matthew L. Fidler
Created
Fri Aug 3 22:33:41 2012 (-0500)
Version
0.12
Package-Requires
((http-post-simple “1.0”) (yaoddmuse “0.1.1”)(header2 “21.0”) (lib-requires “21.0”))
Last-Updated
Sat Aug 11 11:17:03 2012 (-0500)
By
Matthew L. Fidler
Update #
522
URL
https://github.com/mlf176f2/org-readme
Keywords
Header2, Readme.org, Emacswiki, Git
Compatibility
Tested with Emacs 24.1 on Windows.

Possible Dependencies

None

Using org-readme

Org readme is used to:

  • Create/Update a “History” section in the Readme.org based on the changelog section of the Emacs Log.
  • Create/Update a “Library Information” Section Based on the Emacs lisp header.
  • Create/Update a “Possible Dependencies” Section Based on the Emacs lisp header.

All other sections of the Readme.org are then put into the “Commentary” section of the readme.org.

In addition this library defines org-readme-sync, a convenience function that:

  • Asks for a commentary about the library change.
  • Syncs the Readme.org with the lisp file as described above.
  • Updates emacswiki with the library description and the library itself.
  • Updates Marmalade-repo if the library version is different than the version in the server.
  • Updates the git repository with the differences that you posted.

When org-readme-sync is called in a Readme.org file that is not a single lisp file, the function exports the readme in EmacsWiki format and posts it to the EmacsWiki.

EmacsWiki Page Names

When exporting the Readme.org to EmacsWiki, the names are transformed as follows:

History

11-Aug-2012
Added ability to add melpa recipie (Matthew L. Fidler)
11-Aug-2012
Bug fix for pushing tags to a git repository (Matthew L. Fidler)
11-Aug-2012
Another fix for git tags. (Matthew L. Fidler)
11-Aug-2012
Found a bug, let see if tagging works now. (Matthew L. Fidler)
11-Aug-2012
Added Git tagging of new versions. Lets see if it works. (Matthew L. Fidler)
11-Aug-2012
Git push worked. Bumping minor version. (Matthew L. Fidler)
11-Aug-2012
Attempted to push repository again. (Matthew L. Fidler)
11-Aug-2012
Attempt to push with git. Something changed. (Matthew L. Fidler)
11-Aug-2012
Added better Package-Requires tag. (Matthew L. Fidler)
11-Aug-2012
Made request for minor revision earlier, and fixed bug. (Matthew L. Fidler)
11-Aug-2012
Fixed code typo (Matthew L. Fidler)
11-Aug-2012
Bug fix for deleting a section of a Readme.org file. (Matthew L. Fidler)
11-Aug-2012
Testing bug. (Matthew L. Fidler)
11-Aug-2012
Minor bug fix. (Matthew L. Fidler)
11-Aug-2012
Bug fix for comment sync, now Readme.org file is translated to lisp file. Additionally, asks for version bump. (Matthew L. Fidler)
11-Aug-2012
Bug fix for syncing readme. Now the returns should not be as prevalent. (Matthew L. Fidler)
11-Aug-2012
Attempting to post to marmlade again… (Matthew L. Fidler)
11-Aug-2012
Attempting to fix org-readme-marmalade-post. (Matthew L. Fidler)
11-Aug-2012
Bug fix to upload to emacswiki and upload to marmalade-repo (Matthew L. Fidler)
11-Aug-2012
Added marmalade-repo support. Now org-readme should upload to marmalade-repo when the version is different from the latest version. (Matthew L. Fidler)
08-Aug-2012
Fixed preformatting tags in emacswiki post. Previously they may have been replaced with <PRE></pre> instead of <pre></pre>. This makes the emacswiki page display correctly. (Matthew L. Fidler)
07-Aug-2012
To use, put (require ‘ess-smart-underscore) in your ~/.emacs file 7-Aug-2012 Matthew L. Fidler Last-Updated: Sat Aug 11 11:17:19 2012 (-0500)
06-Aug-2012
Added support for uploading Readme.org files to emacswiki without having to have a single associated lisp file. (Matthew L. Fidler)
06-Aug-2012
Bug fix for syncing from the single lisp file. (Matthew L. Fidler)
06-Aug-2012
Added the ability to call org-readme-sync from Readme.org (Matthew L. Fidler)
05-Aug-2012
Added git pushing to org-readme (Matthew L. Fidler)
05-Aug-2012
Added git support as well as a comment mode. The only thing that should need to be called is org-readme-sync (Matthew L. Fidler)
04-Aug-2012
Added syncing with emacswiki. (Matthew L. Fidler)
04-Aug-2012
Initial Release (Matthew L. Fidler)- When the library is a single lisp function, the single lisp file is
Something went wrong with that request. Please try again.