Skip to content

Commit

Permalink
Added more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mattfidler committed Aug 11, 2012
1 parent ddaf4f0 commit 598c12f
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 13 deletions.
18 changes: 13 additions & 5 deletions Readme.md
Expand Up @@ -10,9 +10,9 @@
- __Created__ -- Fri Aug 3 22:33:41 2012 (-0500)
- __Version__ -- 0.18
- __Package-Requires__ -- ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
- __Last-Updated__ -- Sat Aug 11 16:45:40 2012 (-0500)
- __Last-Updated__ -- Sat Aug 11 17:00:39 2012 (-0500)
- __By__ -- Matthew L. Fidler
- __Update #__ -- 646
- __Update #__ -- 648
- __URL__ -- https:__github.com_mlf176f2_org-readme
- __Keywords__ -- Header2, Readme.org, Emacswiki, Git
- __Compatibility__ -- Tested with Emacs 24.1 on Windows.
Expand Down Expand Up @@ -49,6 +49,9 @@ 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
EmacsWiki Page names are generated from the file. `org-readme.el`
would generate a page of OrgReadme.

### Why each required library is needed
There are a few required libraries. This is a list of the require
libraries and why they are needed.
Expand All @@ -62,13 +65,18 @@ libraries and why they are needed.
<tr><th scope="col" align="left">Library</th><th scope="col" align="left">Why it is needed</th></tr>
</thead>
<tbody>
<tr><td align="left">yaoddmuse</td><td align="left">Publishing to emacswiki</td></tr>
<tr><td align="left">yaoddmuse</td><td align="left">Publish to emacswiki</td></tr>
<tr><td align="left">http-post-simple</td><td align="left">Publish to marmalade-repo.org</td></tr>
<tr><td align="left">header2</td><td align="left">To create header and changelog</td></tr>
<tr><td align="left">lib-requires</td><td align="left">To generate the library dependencies</td></tr>
</tbody>
</table>



## History

- __11-Aug-2012__ -- Added more documentation (Matthew L. Fidler)
- __11-Aug-2012__ -- One last bug fix to the markdown export engine. (Matthew L. Fidler)
- __11-Aug-2012__ -- Markdown bug fix (Matthew L. Fidler)
- __11-Aug-2012__ -- Bug fix for el-get recipe. (Matthew L. Fidler)
Expand Down Expand Up @@ -97,11 +105,11 @@ libraries and why they are needed.
- __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 16:45:58 2012 (-0500)
- __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 17:00:54 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)| http-post-simple | Publishing to marmalade-repo.org |
- __04-Aug-2012__ -- Initial Release (Matthew L. Fidler)Another assumption is the primary lisp file is on github.com
25 changes: 17 additions & 8 deletions Readme.org
Expand Up @@ -10,9 +10,9 @@
- Created :: Fri Aug 3 22:33:41 2012 (-0500)
- Version :: 0.18
- Package-Requires :: ((http-post-simple "1.0") (yaoddmuse "0.1.1")(header2 "21.0") (lib-requires "21.0"))
- Last-Updated :: Sat Aug 11 16:45:40 2012 (-0500)
- Last-Updated :: Sat Aug 11 17:00:39 2012 (-0500)
- By :: Matthew L. Fidler
- Update # :: 646
- Update # :: 648
- URL :: https://github.com/mlf176f2/org-readme
- Keywords :: Header2, Readme.org, Emacswiki, Git
- Compatibility :: Tested with Emacs 24.1 on Windows.
Expand Down Expand Up @@ -49,16 +49,25 @@ 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
EmacsWiki Page names are generated from the file. =org-readme.el=
would generate a page of OrgReadme.

** Why each required library is needed
There are a few required libraries. This is a list of the require
libraries and why they are needed.

|------------------+-----------------------------------------------|
| Library | Why it is needed |
|------------------+-----------------------------------------------|
| yaoddmuse | Publishing to emacswiki |
|------------------+--------------------------------------|
| Library | Why it is needed |
|------------------+--------------------------------------|
| yaoddmuse | Publish to emacswiki |
| http-post-simple | Publish to marmalade-repo.org |
| header2 | To create header and changelog |
| lib-requires | To generate the library dependencies |
|------------------+--------------------------------------|

* History

- 11-Aug-2012 :: Added more documentation (Matthew L. Fidler)
- 11-Aug-2012 :: One last bug fix to the markdown export engine. (Matthew L. Fidler)
- 11-Aug-2012 :: Markdown bug fix (Matthew L. Fidler)
- 11-Aug-2012 :: Bug fix for el-get recipe. (Matthew L. Fidler)
Expand Down Expand Up @@ -87,11 +96,11 @@ libraries and why they are needed.
- 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 16:45:58 2012 (-0500)
- 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 17:00:54 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)| http-post-simple | Publishing to marmalade-repo.org |
- 04-Aug-2012 :: Initial Release (Matthew L. Fidler)Another assumption is the primary lisp file is on github.com
5 changes: 5 additions & 0 deletions el-get/Readme
@@ -0,0 +1,5 @@
(:name Readme
:description "Readme"
:website "https://github.com/mlf176f2/org-readme"
:type git
:url "https://github.com/mlf176f2/org-readme.git")
4 changes: 4 additions & 0 deletions melpa/Readme
@@ -0,0 +1,4 @@
(Readme
:repo "mlf176f2/org-readme"
:fetcher github
:files ("Readme.el"))

0 comments on commit 598c12f

Please sign in to comment.