summaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
parente5f4200d404a8817a70734343c6b71ba596297fd (diff)
more dox and close #87
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 13 insertions, 16 deletions
diff --git a/README.md b/README.md
index 0d64081..95c4ab9 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.