summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRyan Wilson <ryan@rdwilson.xyz>2021-03-13 02:04:34 -0400
committerGitHub <noreply@github.com>2021-03-13 02:04:34 -0400
commit0868c2ad4b2261d85edb0a5da0e80eabf1d7b717 (patch)
treea21c832b4a5b976da506b213a6dc3e798f8fa13b /README.md
parent55c2c913fbf2bff94a08d51cf13073a4e135db71 (diff)
parent4e11acbfe41e45a787697af7e68edb6ccaeeb9d8 (diff)
Merge pull request #1 from LukeSmithxyz/master
Merge
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 14 insertions, 14 deletions
diff --git a/README.md b/README.md
index ebc642c..95c4ab9 100644
--- a/README.md
+++ b/README.md
@@ -12,28 +12,28 @@
## 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).
+- 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.
-Recipe must be based, i.e. good traditional and substantial food. Nothing
-ironic, meme-tier hyper-sugary, meat-substitute, etc.
+**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.**
-### Minor rules
-
-- Don't include salt and pepper and other uniquitous things in the ingredients list.
-- If measurements are used, include metric and American measurements. Do not use decimals in American; round or use fractions.
-
-## Images
+### Images
Each recipe can have a title image at the top and perhaps
several instructional images as absolutely necessary.
Do not add stock images you found on the internet.
Take a good picture yourself of the actual dish created.
-If you see a bad or substandard iamge, you may submit a better one.
+If you see a bad or substandard image, you may submit a better one.
-Images should be in `.webp` format.
+Images should be in `.webp` format and with as small file size as possible.
If you submit an image for say, `chicken-parmesan.md`, it should be added as `pix/chicken-parmesan.webp`.
I will create smaller images from that which is seen on the page,
and upon being clicked, the user will see the full-size image.
@@ -74,5 +74,5 @@ This website and all its content is in the public domain.
By submitting text or images or anything else to this repository,
you waive any pretense of ownership to it,
although you are welcome and recommended to give yourself credit
-at the botton of a submitted page for you adding it
+at the bottom of a submitted page for you adding it
(including personal or donation links).