summaryrefslogtreecommitdiffstats
path: root/example.md
diff options
context:
space:
mode:
authorSylvain Gauthier <s94.gauthier@laposte.net>2021-03-14 17:00:36 +1100
committerSylvain Gauthier <s94.gauthier@laposte.net>2021-03-15 10:36:14 +1100
commit5da3d4fa492b9b33a88e1cbdffc674c45debe74b (patch)
tree5f2dee9c455bbb8986db40d5b727c20e88d85c42 /example.md
parentbe0c2dd2ce70a728380738c7aa3cb964b3175234 (diff)
downloadbased.cooking-5da3d4fa492b9b33a88e1cbdffc674c45debe74b.tar
based.cooking-5da3d4fa492b9b33a88e1cbdffc674c45debe74b.tar.gz
based.cooking-5da3d4fa492b9b33a88e1cbdffc674c45debe74b.tar.lz
based.cooking-5da3d4fa492b9b33a88e1cbdffc674c45debe74b.tar.xz
based.cooking-5da3d4fa492b9b33a88e1cbdffc674c45debe74b.zip
re-add/amend example.md and README.md
Diffstat (limited to 'example.md')
-rw-r--r--example.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/example.md b/example.md
new file mode 100644
index 000000000..a53988f0c
--- /dev/null
+++ b/example.md
@@ -0,0 +1,42 @@
+# This is the dish title
+
+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
+
+- List the ingredients
+- in an unordered list
+- similar to this.
+- List amounts if necessary.
+- Put (optional) at the end of optional ingredients
+
+## Directions
+
+1. Now using an ordered list,
+2. give the directions to prepare the dish.
+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
+
+Here, just put your name and links to yourself (maybe a website or donation link) if you want.
+You may say "Anonymous" or a screenname if desired.
+If you add something substantial to an already existing recipe (including and image) you may add your name below with the contribution in parens.
+
+Note that your commit name will be used to sign the recipe, so for full
+anonymity either commit with a name that can't be traced back to you, or ask
+someone else to commit for you.
+
+- Luke Smith - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate)
+- Luke Smith (photo credit) - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate)
+
+;tags: tag1 tag2 tag3 (see README for tag guidelines)