diff options
| author | Simon Holywell <[email protected]> | 2013-01-03 12:50:03 +0000 |
|---|---|---|
| committer | Simon Holywell <[email protected]> | 2013-01-03 12:50:03 +0000 |
| commit | bc3856eebbfeaca821eeddfd1abf384278553851 (patch) | |
| tree | 653d340a66e3a142715926f7466275516c5fb608 /README.markdown | |
| parent | 23fd610734edc8613b00ef20598e6b26d462cc2f (diff) | |
Forgot to mention new documentation build procedures and location
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 252dbcc..34fb6fe 100644 --- a/README.markdown +++ b/README.markdown @@ -22,6 +22,19 @@ Features * Consists of just one class called `ORM`. Minimal global namespace pollution. * Database agnostic. Currently supports SQLite and MySQL. May support others, please give it a try! +Documentation +------------- + +The documentation is hosted on Read the Docs: [idiorm.rtfd.org](http://idiorm.rtfd.org) + +## Building the Docs ## + +You will need to install [Sphinx](http://sphinx-doc.org/) and then in the docs folder run: + + make html + +The documentation will now be in docs/_build/html/index.html + Changelog --------- |