summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73bca0a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+```
+888888b.
+888 Y88b
+888 888
+888 d88P 888 888 .d8888b .d8888b .d88b.
+8888888P" 888 888 d88P" d88P" d88""88b
+888 888 888 888 888 888 888
+888 Y88b 888 Y88b. Y88b. Y88..88P
+888 "Y88888 "Y8888P "Y8888P "Y88P"
+ 888
+ Y8b d88P
+ "Y88P"
+```
+
+Pycco is a Python port of Docco: the original quick-and-dirty, hundred-line-
+long, literate-programming-style documentation generator. For more information,
+see:
+
+https://pycco-docs.github.io/pycco/
+
+Others:
+
+CoffeeScript (Original) - http://jashkenas.github.com/docco/
+
+Ruby - http://rtomayko.github.com/rocco/
+
+Sh - http://rtomayko.github.com/shocco/
+
+[![Build Status](https://travis-ci.org/pycco-docs/pycco.svg?branch=master)](https://travis-ci.org/pycco-docs/pycco)
+[![Coverage Status](https://coveralls.io/repos/pycco-docs/pycco/badge.svg?branch=master&service=github)](https://coveralls.io/github/pycco-docs/pycco?branch=master)