Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Moved README to markdown and added a note about running tests

  • Loading branch information...
commit f9b3cca8f6d3b6a477e09adeb96a5edd6898ee2f 1 parent 92b224e
Michal Migurski authored
Showing with 15 additions and 10 deletions.
  1. +8 −4 INSTALL.md
  2. +6 −5 README.txt → README.md
  3. +1 −1  setup.py
View
12 INSTALL.md
@@ -17,12 +17,12 @@ Dependency information:
Using Pip
- $ pip install cssutils
- $ pip install PIL
+ % pip install cssutils
+ % pip install PIL
On Ubuntu
- $ apt-get install python-cssutils python-imaging
+ % apt-get install python-cssutils python-imaging
Cascadenik
----------
@@ -31,4 +31,8 @@ Cascadenik
Or, run the following command inside this directory:
- $ python setup.py install
+ % python setup.py install
+
+Now run the test suite:
+
+ % python -m cascadenik.tests
View
11 README.txt → README.md
@@ -1,16 +1,17 @@
-- Usage -
+Usage
+=====
-* See INSTALL.txt for installation instructions. *
+See `INSTALL.md` for installation instructions.
-* See the doc/ folder for more usage examples *
+See the `doc/` folder for more usage examples.
Unroll the rules in example.mss and show their cascade order:
% cascadenik-style.py example.mss > example-ordered-unrolled.mss
-Compile example.mml into a Mapnik-suitable XML file:
+Compile `example.mml` into a Mapnik-suitable XML file:
- % cascadenik-compile.py example.mml > example-compiled.xml
+ % cascadenik-compile.py example.mml example-compiled.xml
Render a MML file directly to an image using nik2img.py:
View
2  setup.py
@@ -11,7 +11,7 @@
from distutils.core import setup
HAS_SETUPTOOLS = False
-readme = file('README.txt','rb').read()
+readme = file('README.md','rb').read()
VERSION = open('VERSION.txt', 'r').read().strip()
Please sign in to comment.
Something went wrong with that request. Please try again.