README

   1 Cookbook is a recipe manager written in Python_ using the Django_
   2 framework.
   3
   4 Install
   5 =======
   6
   7 Download
   8 --------
   9
  10 Cookbook is published as a Git_ repository.  See `cookbook's web
  11 interface`__ for more information.
  12
  13 __ cookbook_
  14
  15 Dependencies
  16 ------------
  17
  18 Outside of Django_ and the Python_ standard libraries, the only
  19 required dependencies are Grappelli_, `django-taggit`_ (docs__) and
  20 `python-markdown`_.
  21
  22 __ dt2-docs_
  23
  24 Quick-start
  25 ===========
  26
  27 If you don't have a Django project and you just want to run cookbook as
  28 a stand-alone service, you can use the example project written up in
  29 `example`.  Set up the project (once)::
  30
  31   $ python example/manage.py collectstatic
  32   $ python example/manage.py syncdb
  33
  34 See the `Django documentation`_ for more details.
  35
  36 Run
  37 ===
  38
  39 Run the app on your local host (as many times as you like)::
  40
  41   $ python example/manage.py runserver
  42
  43 You may need to add the current directory to `PYTHONPATH` so `python`
  44 can find the `cookbook` package.  If you're running `bash`, that will
  45 look like
  46
  47   $ PYTHONPATH=".:$PYTHONPATH" python example/manage.py runserver
  48
  49 Hacking
  50 =======
  51
  52 This project was largely build following the `Django tutorial`_.
  53 That's a good place to start if you're new to Django.
  54
  55 .. _Python: http://www.python.org/
  56 .. _Django: https://www.djangoproject.com/
  57 .. _Git: http://git-scm.com/
  58 .. _cookbook: http://physics.drexel.edu/~wking/code/git/gitweb.cgi?p=cookbook.git
  59 .. _Grappelli: https://github.com/sehmaschine/django-grappelli
  60 .. _django-taggit: https://github.com/alex/django-taggit
  61 .. _dt2-docs: http://django-taggit.readthedocs.org/en/latest/
  62 .. _python-markdown: http://pypi.python.org/pypi/Markdown
  63 .. _Django documentation: https://docs.djangoproject.com/
  64 .. _Django tutorial: https://docs.djangoproject.com/en/1.3/intro/tutorial01/