summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuke Smith <luke@lukesmith.xyz>2021-03-12 13:10:58 -0500
committerLuke Smith <luke@lukesmith.xyz>2021-03-12 13:19:58 -0500
commitc7a0d57a510a22d8ad716e41d3b13e8e653d412e (patch)
tree5359473747776c982b7dfeb5237eb30dc802a899
parente5f4200d404a8817a70734343c6b71ba596297fd (diff)
downloadbased.cooking-c7a0d57a510a22d8ad716e41d3b13e8e653d412e.tar
based.cooking-c7a0d57a510a22d8ad716e41d3b13e8e653d412e.tar.gz
based.cooking-c7a0d57a510a22d8ad716e41d3b13e8e653d412e.tar.lz
based.cooking-c7a0d57a510a22d8ad716e41d3b13e8e653d412e.tar.xz
based.cooking-c7a0d57a510a22d8ad716e41d3b13e8e653d412e.zip
more dox and close #87
-rw-r--r--README.md29
-rw-r--r--example.md13
-rw-r--r--src/fried-potatos.md (renamed from src/fried_potatos.md)0
-rw-r--r--src/hangover-eggs.md (renamed from hangover_eggs.md)0
-rw-r--r--src/index.md6
-rw-r--r--src/maque-choux.md (renamed from src/maque_choux.md)0
-rw-r--r--src/scandanavian-coffee-cake.md3
7 files changed, 29 insertions, 22 deletions
diff --git a/README.md b/README.md
index 0d6408179..95c4ab9e2 100644
--- a/README.md
+++ b/README.md
@@ -12,22 +12,19 @@
## Rules for submission
-Add reciples as `.md` files to the `src/` directory.
-Look at already existing `.md` files for examples
-or see [example](example.md).
-
-Recipe must be based, i.e. good traditional and substantial food. Nothing
-ironic, meme-tier hyper-sugary, meat-substitute, etc.
-
-**ADD YOUR RECIPE TO THE LIST ON `index.md` OR NO ONE WILL EVER SEE IT.**
-I've been having to remind most submitters of this, but it's all so tiresome
-so I'm just going to let you add ghost pages now if you don't listen!
-
-### Minor rules
-
-- Don't include salt and pepper and other ubiquitous things in the ingredients list.
-
-## Images
+- Recipes should be `.md` files in the `src/` directory. Look at already
+ existing `.md` files for examples or see [example](example.md).
+- File names should be the name of the dish with words separated by hypens
+ (`-`). Not underscores, and definitely not spaces.
+- Recipe must be based, i.e. good traditional and substantial food. Nothing
+ ironic, meme-tier hyper-sugary, meat-substitute, etc.
+- **ADD YOUR RECIPE TO THE LIST ON `index.md` OR NO ONE WILL EVER SEE IT.**
+- Don't include salt and pepper and other ubiquitous things in the ingredients
+ list.
+
+**If you fail to do these things, I will close your submission and you will have to resubmit. I am tired of having to fix more than 50% of submissions.**
+
+### Images
Each recipe can have a title image at the top and perhaps
several instructional images as absolutely necessary.
diff --git a/example.md b/example.md
index 9927a7116..dfb3d052b 100644
--- a/example.md
+++ b/example.md
@@ -3,6 +3,11 @@
If necessary, provide a very brief description of the dish in one or two sentences.
For most dishes, this will be unnecessary.
If there is a title image of this dish, it should be above this paragraph.
+You may also include prep/cook time and the number of servings as below:
+
+- ⏲️ Prep time: 10 min
+- 🍳Cook time: 30 min
+- 🍽️ Servings: 4
## Ingredients
@@ -16,10 +21,10 @@ If there is a title image of this dish, it should be above this paragraph.
1. Now using an ordered list,
2. give the directions to prepare the dish.
-3. If necessary,
-4. an image can be included between some directions if needed to explain something particular.
-5. But that should be kept to a minimum to reduce bandwidth and aid in simplicity.
-
+3. Do **not** add unnecessary blank lines between items.
+4. If necessary,
+5. an image can be included between some directions if needed to explain something particular.
+6. But that should be kept to a minimum to reduce bandwidth and aid in simplicity.
## Contribution
diff --git a/src/fried_potatos.md b/src/fried-potatos.md
index 476d1fbb6..476d1fbb6 100644
--- a/src/fried_potatos.md
+++ b/src/fried-potatos.md
diff --git a/hangover_eggs.md b/src/hangover-eggs.md
index d4f9693e7..d4f9693e7 100644
--- a/hangover_eggs.md
+++ b/src/hangover-eggs.md
diff --git a/src/index.md b/src/index.md
index c86bf0216..de317c733 100644
--- a/src/index.md
+++ b/src/index.md
@@ -40,6 +40,9 @@ Only Based cooking. No ads, no tracking, nothing but based cooking.
- [Banana Muffins with Chocolate](banana-muffins-with-chocolate.html)
- [Taco Meat](taco-meat.html)
- [Fried Anglerfish Fillet](fried-anglerfish-fillet.html)
+- [Hangover Eggs](hangover-eggs.html)
+- [Caesar Salad](caesar-salad.md)
+- [Maque Choux](maque-choux.html)
## Basics
@@ -53,7 +56,8 @@ Only Based cooking. No ads, no tracking, nothing but based cooking.
- [Sauerkraut](sauerkraut.html)
- [Yogurt](yogurt.html)
- [Sweet Potato Fries](sweet-potato-fries.html)
-- [Fried potatos](fried_potatos.html)
+- [Fried potatos](fried-potatos.html)
+- [Croutons](croutons.html)
## More Info
diff --git a/src/maque_choux.md b/src/maque-choux.md
index b55f1baa8..b55f1baa8 100644
--- a/src/maque_choux.md
+++ b/src/maque-choux.md
diff --git a/src/scandanavian-coffee-cake.md b/src/scandanavian-coffee-cake.md
index 6cc25c7f4..216d0ecf7 100644
--- a/src/scandanavian-coffee-cake.md
+++ b/src/scandanavian-coffee-cake.md
@@ -36,4 +36,5 @@
18. While warm spread with confectioners' sugar icing; sprinkle with chopped walnuts.
## Contribution
-Anonymous
+
+- Anonymous