Some documentation.

[pelican-mode.git] / README.md

diff --git a/README.md b/README.md
index ceec3d7..9463fe7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
-# pelican-mode
-
-pelican-mode is a minor mode for editing pages and posts in [Pelican]
-sites. It's intended to be used alongside [markdown-mode] or
-[rst-mode].
+pelican-mode is an Emacs minor mode for editing pages and posts in
+[Pelican][] sites.
 
+It's intended to be used alongside [markdown-mode][] or [rst-mode][].
 It also assumes you've set up Pelican with `pelican-quickstart` or
 something like it. In particular it assumes:
 
@@ -14,34 +12,31 @@ something like it. In particular it assumes:
  * If the next component is `pages`, that indicates a static page
    rather than a dated post.
    
-It also enforces some parts of my preferred Pelican configuration:
-
- * Categories are never provided (you can have one if you want, but
-   the default interactive commands don't provide one).
- * Tags are always provided.
- * Slugs are explicit, and include nested subdirectories.
 
 ## Quick Guide
 
-* `C-x p n` - Insert a post or page header
-* `C-x p p` - Remove draft status from a post (i.e. publish it)
-* `C-x p t` - Update the date field in a post/page header
-* `C-x p h` - Generate HTML output for a site (equivalent to `make html`)
-* `C-x p u` - Upload a site using rsync (equivalent to `make rsync_upload`)
+* `C-c P n` - Insert a post or page header
+* `C-c P p` - Remove draft status from a post (i.e. publish it)
+* `C-c P t` - Update the date field in a post/page header
+* `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
+* `C-c P u` - Upload a site using rsync (equivalent to `make rsync_upload`)
+
 
 ## Troubleshooting
 
 If the commands which invoke `make` can find the Makefile but can't
 find `pelican`, your `exec-path` may not be set right. Try out
-[exec-path-from-shell].
+[exec-path-from-shell][].
+
 
 ## License
 
-This code is released into the public domain via the
-[CC0 Public Domain Dedication][0].
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at
+your option) any later version.
 
  [Pelican]: http://getpelican.com/
  [markdown-mode]: http://jblevins.org/projects/markdown-mode/
  [rst-mode]: http://docutils.sourceforge.net/docs/user/emacs.html
  [exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell
- [0]: http://creativecommons.org/publicdomain/zero/1.0/legalcode