~vorlon/ubuntu/saucy/gourmet/trunk

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Rolf Leggewie
  • Date: 2009-01-12 23:03:28 UTC
  • mfrom: (2.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090112230328-wnuqqte22uk3981b
Tags: 0.14.3-2
Conflict with python-pysqlite >= 2.5 which when installed crashes 
gourmet at startup. (Closes: #507382) and python-sqlalchemy >= 0.5.
Both restrictions should eventually be relaxed when upstream has
made the code compatible with the newer libs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
* Introduction *
2
 
 
3
 
Gourmet Recipe Manager is a manager, editor, and organizer for
4
 
recipes. It currently has support for MealMaster(tm) and
5
 
MasterCook(tm) import, including 1 and 2 column MealMaster recipes and
6
 
plain text and XML MasterCook(tm). It can also export and import an XML
7
 
format of its own (the DTD is included here for your interest) which I
8
 
developed for an earlier recipe program in emacs-lisp. It also allows
9
 
you to export recipes as MealMaster(tm), HTML, RTF or Plain Text.
10
 
 
11
 
Furthermore, to facilitate copying recipes off the web, you can drag a
12
 
list of ingredients from another application (i.e. your web browser)
13
 
to the ingredient list on the Recipe Card view and they will
14
 
automatically be imported (the program will do the best it can parsing
15
 
amounts, units and ingredients -- you can quickly see and correct any
16
 
problems). This can also be done with a list of ingredients in the
17
 
clipboard or in a text file.
18
 
 
19
 
In addition to allowing you to edit, import, search and categorize
20
 
recipes, Gourmet generates shopping lists sorted by category. It has a
21
 
simple mechanism for allowing you to designate "pantry" items that you
22
 
already have and don't need to buy, which will gourmet will remember
23
 
between sessions.
24
 
 
25
 
Gourmet also includes a handy unit converter to quickly allow you to
26
 
convert any measurement (it even knows the densities of a number of
27
 
common foods!).
28
 
 
29
 
The default and best supported backend for Gourmet is metakit -- a
30
 
all-in-a-file database that you don't need to know anything
31
 
about. Gourmet can also be used with sqlite or with MySQL. Support for
32
 
these databases is experimental at present.
33
 
 
34
 
This program aspires to meet the GNOME Human Interface
35
 
Guidelines. Please let me know if you see any ways the interface could
36
 
become more GNOME HIG compliant (or just improve in general).
37
 
 
38
 
* Minimum Requirements *
39
 
 
40
 
1. Python 2.2
41
 
2. PyGTK>2.3.9 and PyGNOME 
42
 
   (Note: with pygtk > 2.5, pygnome bindings have been split up.
43
 
    To print, you'll need e.g. the python-gnome2-extras package as
44
 
    well as the the python-gnome2 package).
45
 
3. libglade
46
 
4. Metakit & Python Metakit bindings (on debian, this is the
47
 
libmetakit-python package). Note: Gourmet can be run without
48
 
metakit if you use the SQLite or MySQL backends, but these are experimental
49
 
at present.
50
 
5. distutils (to install). Provided by python-dev package.
51
 
6. Python Imaging Libraries (PIL)
52
 
 
53
 
* Extra Requirements *
54
 
 
55
 
1. For RTF support, you will need the PyRTF library available
56
 
   at http://pyrtf.sourceforge.net
57
 
 
58
 
2. Gnomeprint bindings, for nice python printing. This is packaged
59
 
   differently in different places and versions, but will likely be in
60
 
   something called "python-gnome" or "pygtk-extras".
61
 
 
62
 
* Install *
63
 
 
64
 
As root, issue a python setup.py install.
65
 
 
66
 
That should be all you need. You can now simply issue
67
 
 
68
 
gourmet
69
 
 
70
 
from the commandline. Alternatively, use the nifty launcher
71
 
installed in /usr/share/applications/
72
 
 
73
 
Gourmet also has commandline options, most of which should not be
74
 
needed by an average user. Issuing gourmet --help will get you help
75
 
for those options.
76
 
 
77
 
* Warning *
78
 
 
79
 
No warantee, etc. Please inform me of bugs/problems/feature
80
 
requests and I'll respond as quickly as I can. I can be reached
81
 
at Thomas_Hinkle@alumni.brown.edu
82
 
 
83
 
* Brief manual *
84
 
 
85
 
Gourmet is intended to be intuitive to use. If anything is completely
86
 
non-obvious, I'll consider that a bug: let me know and I'll try to fix
87
 
it.
88
 
 
89
 
To use Gourmet, the first thing you'll need are some recipes in your
90
 
database. You can get recipes by importing MealMaster(tm) files or by
91
 
entering recipes manually (click "New Recipe"). Or you could write a
92
 
new importer module for whatever file format you have recipes in
93
 
*grin*.
94
 
 
95
 
There is somewhat out-of-date and incomplete documentation available
96
 
in the documentation folder. On a GNOME system, type yelp
97
 
documentation/documentation.xml (from the gourmet source folder) and
98
 
you can read what's done so far. This isn't yet properly installed by
99
 
setup.py.
100
 
 
101
 
The Gourmet program has three kinds of windows.
102
 
 
103
 
The first is a index view for looking at your collection. It has a
104
 
search-as-you-type search box that is meant to let you quickly find
105
 
your recipes. You can also create complex searches by using the add
106
 
button next to the search box to combine searches. From this view, you
107
 
can click the "View Recipe" button to see a recipe card view of your
108
 
recipe. Note that currently, the search box excepts regular
109
 
expressions.
110
 
 
111
 
The Card View shows you a recipe at a time, and doubles as an editor,
112
 
allowing you to conveniently edit old recipes and input new ones. The
113
 
recipe card window has multiple tabs -- the first tab is simply a
114
 
display of the recipe; the other tabs allow you to edit details of
115
 
your recipe: title and details, instructions, ratings, notes, an
116
 
image, and, of course, an ingredient list. To edit ingredients in a
117
 
typing-efficient way, use the ingredient editor at the bottom of the
118
 
cardView. This is set up to allow you to quickly type "amount TAB unit
119
 
TAB item TAB alt-A (for Add)"
120
 
 
121
 
Ingredients use a key system, so that when Gourmet generates shopping
122
 
lists, it will know that, for example, "aubergine", "eggplant" and
123
 
"eggplant, halved" are all the same thing. The program will learn keys
124
 
as you go, so that if you tell it once that "flour" should be keyed as
125
 
"flour, all purpose", then every time you type "flour" it will
126
 
automatically set the key to "flour, all purpose". It will also try to
127
 
guess keys as best it can, which is usually helpful but may
128
 
occasionally lead to incorrect results.
129
 
 
130
 
You can also drag and drop a list of ingredients from another program
131
 
onto the ingredient list and they will be imported -- the program does
132
 
the best it can to parse out units and amounts, but you will probably
133
 
have to correct some mistakes by hand.
134
 
 
135
 
In addition to having keys for ingredients, Gourmet keeps track of
136
 
shopping categories so that your shopping lists are sorted. If you're
137
 
going to use Gourmet for shopping lists and you like your shopping
138
 
lists sorted, then you should enter categories when it's
139
 
convenient. Any time you tell Gourmet what category something is in,
140
 
it will remember for the future.
141
 
 
142
 
The Shopping List View contains your shopping list. You can add
143
 
recipes to the shopping list from the index (where you can select
144
 
multiple recipes at a time to add) or from recipe cards. This view has
145
 
both a shopping list and a "pantry list" (ingredients called for in
146
 
your recipe that you don't need to buy). You can move ingredients
147
 
between the lists by dragging and dropping between the two lists, by
148
 
right clicking and selecting "move to pantry." You can also change the
149
 
categories for items in your lists by right-clicking and selecting a
150
 
new category or by using drag-and-drop.
151
 
 
152
 
Finally, you can add arbitrary items to the shopping list by clicking
153
 
on the "Add" button at the bottom of the screen.
154
 
 
155
 
From the shopping list, you can export a simple text file or you can
156
 
print. Printing will use the nice gnomeprint interface if available,
157
 
offering a print preview and relatively attractive layout. If not
158
 
available, printing will allow you to pipe the recipe in plain text to
159
 
lpr or another print command of your choosing.
160
 
 
161
 
----
162
 
 
163
 
If you find this program useful, or have any comments or questions,
164
 
please e-mail to let me know at Thomas_Hinkle@alumni.brown.edu
 
 
b'\\ No newline at end of file'