From 66dafbb3fbafe0458ba1167931bc04892ade2756 Mon Sep 17 00:00:00 2001 From: cos Date: Sat, 18 Jan 2014 11:44:48 +0100 Subject: Added initial README file. --- README | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..6ec033e --- /dev/null +++ b/README @@ -0,0 +1,20 @@ +Mat is small a recipe management, food planning & lunch box inventory system. +It was written with the aim to help me, who hates cooking, to be able to eat at +regular intervals when working in an area with no decent restaurants. + +If for some obscure reason, you would like to use this hackish beast, the first +thing you need to do is create a sqlite database with the following schema: + +CREATE TABLE recipes (id INTEGER PRIMARY KEY AUTOINCREMENT, name, uri, servings INTEGER); +CREATE TABLE ingredients (id INTEGER PRIMARY KEY AUTOINCREMENT, name, shop_position INTEGER); +CREATE TABLE contents (recipe_id INTEGER, ingredient_id INTEGER, quantity FLOAT, unit); +CREATE TABLE plan (date DATETIME, mealtype, recipe_id INTEGER, state, comment_id); +CREATE TABLE comments (id INTEGER PRIMARY KEY AUTOINCREMENT, comment); +CREATE TABLE inventory (id INTEGER PRIMARY KEY AUTOINCREMENT, recipe_id INTEGER, amount INTEGER, storage); + +All basic operations are performed using the perl script mat. It is possible to +get a crude list of commands available by running: "mat help". + +(Oh yeah! You might find the code quality & lack of design rubbish. That's +completely sane & so do I. I only ever code on this while also cooking. E.g. +when waiting for the stove & the oven to do its work.) -- cgit v1.2.3