instructions

This commit is contained in:
fitcooking 2021-10-08 00:14:19 +02:00
parent b76f29acf5
commit d9850d290d
2 changed files with 118 additions and 2 deletions

View File

@ -1,2 +1,74 @@
# fitcooking
# Based Cooking Website
[https://fit.cooking](https://fit.cooking)
This is a simple cooking website where users can submit recipes here for credit.
There are no ads, trackers, cookies (unless recipes thereof) or javascript.
## Ways to contribute
- By adding a recipe.
- Make a recipe and take a nice picture of it if no nice picture already
exists. Submitted images should be small `.webp` files ideally less than 100K
or so.
- Fix errors in recipes or add minor improvements.
## Rules for submission
- Model submission files after [example.md](example.md). Put them in `src/`.
- /fit/ infographics should be a simple .md file with the picture inside. put them in `fitposts/`
- 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
should be automatic).
- File names should be the name of the dish with words separated by hyphens
(`-`). 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.
- 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.**
### Tags
You can (and should) add tags at the end of your recipe. The syntax is:
```
;tags: tag1 tag2 tag3
```
The tag line should be a single line, at the end of the markdown file, preceded
by a blank line.
Add between 1 and 4 tags, **prioritize existing tags**. As a general guideline,
add the country from which the recipe originates if the recipe is representative
of said country, using the adjective form (eg. *mexican*, *italian*, etc). Tag
the main ingredient if it's something slightly special.
List of special, categorical tags to use if relevant:
- `basic`: for basic recipes that aren't meant to be stand alone but are supposed
to be incorporated in another recipe.
- `breakfast`
- `dessert`
- `quick`: for recipes that can be cooked in under ~20 minutes.
- `side`: side dishes such as mash, fries, etc.
- `snack`
- `spread`
### Images
Images are stored in `/pix`.
Images for /fit/ infographics are stored in `/fitpics`
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.
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.

44
example.md Normal file
View File

@ -0,0 +1,44 @@
# 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
- There must be a blank line above all lists.
- 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 "Anon" 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.
- Billy Smith - btc: `bc1q763s4ud0hgfa66ce64gyh6tsss49vyk5cqcm6w`
;tags: tag1 tag2 tag3 (see README for tag guidelines)