Skip to content
This repository has been archived by the owner on Nov 19, 2018. It is now read-only.

Commit

Permalink
Revert "docs(README.md): remove noise"
Browse files Browse the repository at this point in the history
This reverts commit 21d97f5.
  • Loading branch information
rnicholus committed Feb 21, 2017
1 parent a8832a1 commit 7a90223
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,32 @@
docfu
=====

| Shaolin shadowboxing, and the docfu sword style
| If what you say is true, the Shaolin and the docfu could be dangerous.
| Do you think your docfu sword can defeat me?
| En garde, I'll let you try my docfu style.

With docfu you can keep writing your project's documentation in same ol' [Markdown](http://daringfireball.net/projects/markdown/)
(via [python-markdown](https://pypi.python.org/pypi/Markdown)), but you can (optionally) add templating logic
(via [Jinja2](http://jinja.pocoo.org/)).

docfu works when given a directory, git repository (optionally a tag or branch), and shortened GitHub urls (feltnerm/docfu).
This makes it a great tool for a git post-commit hook or as just a regular ol' documentation generator.

docfu is at most alpha status right now. Please post ideas and bugs to the `issue tracker`_.

.. _issue tracker: https://github.com/feltnerm/docfu/issues

Contributions are welcome as well!

Installation:
-------------

*DUH-DUH-DUH...enter the docfu zone ...*

::

$ git clone https://github.com/FineUploader/docfu
$ git clone https://github.com/feltnerm/docfu
$ cd docfu
$ python setup.py install

Expand All @@ -23,13 +36,21 @@ Development:

::

$ git clone https://github.com/FineUploader/docfu
$ git clone https://github.com/feltnerm/docfu
$ virtualenv docfu-env
$ source docfu-env/bin/activate
$ cd docfu
$ python setup.py install


Usage:
------

| The game of chess is like a swordfight
| You must think first before you move
| Toad style is immensely strong and immune to nearly any weapon
| When it's properly used it's almost invincible

::

usage: docfu [-h] [-c CONFIG] [-b BRANCH] [-t TAG] [-r ROOT_DIR]
Expand Down Expand Up @@ -69,22 +90,27 @@ Development:
Examples:
---------

| Straight from the slums of Shaolin
| docfu Killa B'z on a swarm

Using a git repository url:
~~~~~~~~~~~~~~~~~~~~~~~
``docfu "https://github.com/FineUploader/docfu" "/home/feltnerm/public_html/docs"```
``docfu "https://github.com/feltnerm/docfu" "/home/feltnerm/public_html/docs"```

Using a short GitHub url:
~~~~~~~~~~~~~~~~~~~~~~~~~
``docfu "FineUploader/docfu" "/home/feltnerm/public_html/docs"```
``docfu "feltnerm/docfu" "/home/feltnerm/public_html/docs"```

Specify directories:
~~~~~~~~~~~~~~~~~~~~~~~
``docfu --root-dir "docs" --source-dir "src" --templates-dir "templates" --assets-dir "assets" FineUploader/docfu" "/home/feltnerm/public_html/docs"``
``docfu --root-dir "docs" --source-dir "src" --templates-dir "templates" --assets-dir "assets" feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific tag
~~~~~~~~~~~~~~~~~~~~~~~
``docfu --tag "0.1" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific branch
~~~~~~~~~~~~~~~~~~~~~~~
``docfu --branch "develop" "FineUploader/docfu" "/home/feltnerm/public_html/docs"``
``docfu --branch "develop" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

*From the slums of Shaolin, docfu strikes again*

0 comments on commit 7a90223

Please sign in to comment.