Rewrite to Django from scratch. Now it's much more user-friendly.

[cookbook.git] / README

diff --git a/README b/README
index 152440d6e32f9109d9b3e8ee759d59249eaa52ee..e7515633db52e1e3188bd1c51350221c06db95b9 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,60 @@
-Cookbook provides a Python interface to your recipes so you can throw
-out all those index cards.
+Cookbook is a recipe manager written in Python_ using the Django_
+framework.
 
-The entry script:
-  ./bin/cook.py
-fires up the server, binding it to a local interface/port.  It also
-translates cookbook formats, e.g. from my mom's rough text file to the
-more robust directory of YAML files that Cookbook uses internally.
+Install
+=======
 
-The recipes themselves will generally be stored in per-recipe YAML
-files under 'recipe'.
+Download
+--------
 
-Send any bug reports to W. Trevor King <wking@drexel.edu>.
+Cookbook is published as a Git_ repository.  See `cookbook's web
+interface`__ for more information.
+
+__ cookbook_
+
+Dependencies
+------------
+
+Outside of Django_ and the Python_ standard libraries, the only
+required dependency is `django-taggit`_ (docs__).
+
+__ dt2-docs_
+
+Quick-start
+===========
+
+If you don't have a Django project and you just want to run cookbook as
+a stand-alone service, you can use the example project written up in
+`example`.  Set up the project (once)::
+
+  $ python example/manage.py syncdb
+
+See the `Django documentation`_ for more details.
+
+Run
+===
+
+Run the app on your local host (as many times as you like)::
+
+  $ python example/manage.py runserver
+
+You may need to add the current directory to `PYTHONPATH` so `python`
+can find the `cookbook` package.  If you're running `bash`, that will
+look like
+
+  $ PYTHONPATH=".:$PYTHONPATH" python example/manage.py runserver
+
+Hacking
+=======
+
+This project was largely build following the `Django tutorial`_.
+That's a good place to start if you're new to Django.
+
+.. _Python: http://www.python.org/
+.. _Django: https://www.djangoproject.com/
+.. _Git: http://git-scm.com/
+.. _cookbook: http://physics.drexel.edu/~wking/code/git/gitweb.cgi?p=cookbook.git
+.. _django-taggit: https://github.com/alex/django-taggit
+.. _dt2-docs: http://django-taggit.readthedocs.org/en/latest/
+.. _Django documentation: https://docs.djangoproject.com/
+.. _Django tutorial: https://docs.djangoproject.com/en/1.3/intro/tutorial01/