summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Smith <luke@lukesmith.xyz>2022-04-15 14:59:55 -0400
committerLuke Smith <luke@lukesmith.xyz>2022-04-15 14:59:55 -0400
commitbd53209ee56973823295077667bce3c122e97559 (patch)
tree48c60a4936cc199b3f267c3d8b8a7599ed321ac3
parent3f368f2f983b1d082a0e40b9f05643ee23a2695a (diff)
readme and example updates
-rw-r--r--README.md27
-rw-r--r--example.md21
2 files changed, 24 insertions, 24 deletions
diff --git a/README.md b/README.md
index b87c18e..dd95bd2 100644
--- a/README.md
+++ b/README.md
@@ -15,10 +15,10 @@ There are no ads, trackers, cookies (unless recipes thereof) or javascript.
## Rules for submission
-- Model submission files after [example.md](example.md). Put them in `src/`.
+- Model submission files after [example.md](example.md). Put them in `content/`.
- Recipes should start with a title, with a single `#`, *on the first line*. No
empty line at the top, no trailing line at the end. The file needs to be `\n`
- terminated in linux-fashion (if you're on linux you don't need to care, it
+ terminated in unix-fashion (if you're on linux you don't need to care, it
should be automatic).
- File names should be the name of the dish with words separated by hyphens
(`-`). Not underscores, and definitely not spaces.
@@ -29,6 +29,11 @@ There are no ads, trackers, cookies (unless recipes thereof) or javascript.
**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.**
+You may include a json file with your personal links/donation addresses in
+`data/authors/your-name.json`. See mine (`data/authors/luke-smith.json`) for a
+model. You can include: `website`, `donate` (general donation link), `email` or
+crypto addresses as `btc`, `xmr` and `eth`.
+
### Tags
Remember to add tags to your recipe, but try to use tags already used by other recipes.
@@ -40,19 +45,23 @@ If it includes dairy but no milk, incude the `cheesefare` tag.
Images are stored in `/pix`.
-Each recipe can have a title image at the top and perhaps
-several instructional images as absolutely necessary.
+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 image, you may submit a better one.
+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 image, you may
+submit a better one.
-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`.
+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`.
If you would like to add additional directional images,
they should be numbered with two digits like: `pix/chicken-parmesan-01.webp`, etc.
+Note also that images should have links beginning with a slash in this use
+case, i.e. `/pix/...`.
+
## License
This website and all its content is in the public domain.
diff --git a/example.md b/example.md
index 7500c14..1aeff4e 100644
--- a/example.md
+++ b/example.md
@@ -2,6 +2,7 @@
title: Dish Title
tags: ['beef', 'soup', 'german']
date: 2022-02-20
+author: "Your Name"
---
If necessary, provide a very brief description of the dish in one or two sentences.
@@ -31,18 +32,8 @@ You may also include prep/cook time and the number of servings as below:
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 an 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.
-
-If you add a Bitcoin/Monero address, put it in "code" between \`'s, like below. This is for formatting, especially with long Monero addresses.
-
-- Luke Smith - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate)
-- Billy Smith - btc: `bc1q763s4ud0hgfa66ce64gyh6tsss49vyk5cqcm6w`
-- Sally Smith (photo credit) - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate)
+Note that you can create a `your-name.json` file in `data/authors` to add
+personal links and donation addresses if you want more specific credit. If you
+do this, for the `author:` line the in the metadata, include the bare file name
+of the json file. For example, my file is `data/authors/luke-smith.json`, so I
+would put `author: luke-smith`.