Skip to content
This repository
Browse code

Moved README to markdown and added a note about running tests

  • Loading branch information...
commit f9b3cca8f6d3b6a477e09adeb96a5edd6898ee2f 1 parent 92b224e
authored May 01, 2012
12  INSTALL.md
Source Rendered
@@ -17,12 +17,12 @@ Dependency information:
17 17
 
18 18
 Using Pip
19 19
 
20  
-    $ pip install cssutils
21  
-    $ pip install PIL
  20
+    % pip install cssutils
  21
+    % pip install PIL
22 22
 
23 23
 On Ubuntu
24 24
 
25  
-    $ apt-get install python-cssutils python-imaging
  25
+    % apt-get install python-cssutils python-imaging
26 26
 
27 27
 Cascadenik
28 28
 ----------
@@ -31,4 +31,8 @@ Cascadenik
31 31
 
32 32
 Or, run the following command inside this directory:
33 33
 
34  
-    $ python setup.py install
  34
+    % python setup.py install
  35
+
  36
+Now run the test suite:
  37
+
  38
+    % python -m cascadenik.tests
11  README.txt → README.md
Source Rendered
... ...
@@ -1,16 +1,17 @@
1  
-- Usage -
  1
+Usage
  2
+=====
2 3
 
3  
-* See INSTALL.txt for installation instructions. *
  4
+See `INSTALL.md` for installation instructions.
4 5
 
5  
-* See the doc/ folder for more usage examples *
  6
+See the `doc/` folder for more usage examples.
6 7
 
7 8
 Unroll the rules in example.mss and show their cascade order:
8 9
 
9 10
     % cascadenik-style.py example.mss > example-ordered-unrolled.mss
10 11
 
11  
-Compile example.mml into a Mapnik-suitable XML file:
  12
+Compile `example.mml` into a Mapnik-suitable XML file:
12 13
 
13  
-    % cascadenik-compile.py example.mml > example-compiled.xml
  14
+    % cascadenik-compile.py example.mml example-compiled.xml
14 15
 
15 16
 Render a MML file directly to an image using nik2img.py:
16 17
 
2  setup.py
@@ -11,7 +11,7 @@
11 11
     from distutils.core import setup
12 12
     HAS_SETUPTOOLS = False
13 13
     
14  
-readme = file('README.txt','rb').read()
  14
+readme = file('README.md','rb').read()
15 15
 
16 16
 VERSION = open('VERSION.txt', 'r').read().strip()
17 17
 

0 notes on commit f9b3cca

Please sign in to comment.
Something went wrong with that request. Please try again.