diff options
| author | Luke Smith <luke@lukesmith.xyz> | 2022-04-15 14:59:55 -0400 |
|---|---|---|
| committer | Luke Smith <luke@lukesmith.xyz> | 2022-04-15 14:59:55 -0400 |
| commit | bd53209ee56973823295077667bce3c122e97559 (patch) | |
| tree | 48c60a4936cc199b3f267c3d8b8a7599ed321ac3 /README.md | |
| parent | 3f368f2f983b1d082a0e40b9f05643ee23a2695a (diff) | |
readme and example updates
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 18 insertions, 9 deletions
@@ -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. |