aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2022-08-19 01:36:57 +0530
committerArun Isaac2022-08-19 01:38:43 +0530
commitef45c78ab73c2cd28a160cc33eb4ce50f0ba84f7 (patch)
tree16009439f293065cd1fe43e4da8389c87f2c3cfc
parent504f83e4f447c926e70fea284dbab36065f7005c (diff)
downloadennum-ef45c78ab73c2cd28a160cc33eb4ce50f0ba84f7.tar.gz
ennum-ef45c78ab73c2cd28a160cc33eb4ce50f0ba84f7.tar.lz
ennum-ef45c78ab73c2cd28a160cc33eb4ce50f0ba84f7.zip
Add usage instructions.
* README.org (Usage): New section.
-rw-r--r--README.org18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.org b/README.org
index ac9094b..89a60ac 100644
--- a/README.org
+++ b/README.org
@@ -47,3 +47,21 @@ Add the path to the cloned repository to your load path, and load ennum.
(add-to-list 'load-path "~/ennum")
(require 'ennum)
#+END_SRC
+
+* Usage
+
+Set up /ennum-blog/ with settings relevant for your blog, and run /M-x ennum-publish/. A simple sample /ennum-blog/ is given below. For detailed documentation of all available settings, see its docstring.
+#+BEGIN_SRC emacs-lisp
+ (setq ennum-blog
+ '(:working-directory "~/blog"
+ :output-directory "output"
+ :posts-directory "posts"
+ :images-directory "images"
+ :static-directory "files"
+ :video-directory "videos"
+
+ :blog-title "Muthu Mani Maalai"
+ :blog-subtitle "Mani's blog"
+ :blog-domain "example.org"
+ :blog-license "All content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License."))
+#+END_SRC