Browse Source

Updated README

Swaroop C H 12 years ago
parent
commit
4259779297
1 changed files with 10 additions and 4 deletions
  1. 10 4
      README.md

+ 10 - 4
README.md

@@ -2,7 +2,8 @@
 
 ## Installation
 
-Ensure Python (>= 2.7) is installed.
+Ensure Python (>= 2.7) is installed for compiling the sources. You
+will need Python 3 to run the Python programs itself.
 
 Install Pandoc >= 1.11.1 from <http://johnmacfarlane.net/pandoc/installing.html>
 
@@ -13,12 +14,10 @@ Install `pip` if not present already:
 
     sudo sh -c "curl -k -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py && python get-pip.py && rm get-pip.py"
 
-
 Install Python libraries needed:
 
     sudo pip install -r requirements.txt
 
-
 Convert the source files into HTML files:
 
     fab html
@@ -33,4 +32,11 @@ Convert the source files into EPUB (ebook):
 
 ## Editing
 
-If you're using Vim editor, then you may like the [vim-pandoc](https://github.com/vim-pandoc/vim-pandoc) plugin. There is one downside though - for long chapters, it becomes really slow, so I edit only in plain text mode (`:set ft=`), but when reviewing, I use the `pandoc` (`:set ft=pandoc`) mode.
+If you're using Emacs, you must use
+[Jason Blevins' Markdown Mode](http://jblevins.org/projects/markdown-mode/).
+
+If you're using Vim, then you may like the
+[vim-pandoc](https://github.com/vim-pandoc/vim-pandoc) plugin. There
+is one downside though - for long chapters, it becomes really slow, so
+I edit only in plain text mode (`:set ft=`), but when reviewing, I use
+the `pandoc` (`:set ft=pandoc`) mode.