junk rm'd

pull/243/head
Luke Smith 3 years ago
parent fecd760b26
commit 742fb7a14c
No known key found for this signature in database
GPG Key ID: 4C50B54A911F6252

@ -2,22 +2,24 @@
[https://based.cooking](https://based.cooking) [https://based.cooking](https://based.cooking)
## To-do This is a simple cooking website where users can submit recipes here for credit.
There are no ads, trackers, cookies (unless reciples thereof) or javascript.
- get many recipes ## Ways to contribute
- make and take pictures of recipes
- decide on CSS/styling, something good-looking and readable, but nothing too complicated - By adding a recipe.
- search function? See below - Make a recipe and take a nice picture of it if no nice picture already
- keep it simple exists. Submitted images should be small `.webm` files ideally less than 100K
or so.
- Fix errors in recipes or add minor improvements.
## Rules for submission ## Rules for submission
- Model submission files after [example.md](example.md). Put them in `src/`.
- Recipes should start with a title, with a single `#`, *on the first line*. No - Recipes should start with a title, with a single `#`, *on the first line*. No
empty line at the top, not trailing line at the end. The file needs to be `\n` empty line at the top, not 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 linux-fashion (if you're on linux you don't need to care, it
should be automatic). should be automatic).
- 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 hyphens - File names should be the name of the dish with words separated by hyphens
(`-`). Not underscores, and definitely not spaces. (`-`). Not underscores, and definitely not spaces.
- Recipe must be based, i.e. good traditional and substantial food. Nothing - Recipe must be based, i.e. good traditional and substantial food. Nothing
@ -66,8 +68,6 @@ 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. 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 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.
If you would like to add additional directional images, If you would like to add additional directional images,
they should be numbered with two digits like: `pix/chicken-parmesan-01.webp`, etc. they should be numbered with two digits like: `pix/chicken-parmesan-01.webp`, etc.
@ -83,18 +83,6 @@ This is not necessary yet though.
I don't really want images of recipes on the mainpage yet. I don't really want images of recipes on the mainpage yet.
I'll think about how best to do it to minimize bandwidth if possible. I'll think about how best to do it to minimize bandwidth if possible.
## curl/Search function in the future
I eventually want a command-line/curl interface to this site.
Part of this would be an implicit search function.
So suppose someone wants a recipe with chicken, I'd like
`curl based.cooking/chicken` to return articles with that title.
If there is only one result, that page is opened.
Just something to think about.
Then people could make a simple two or three character alias to get a simple text recipe.
## License ## License
This website and all its content is in the public domain. This website and all its content is in the public domain.

Loading…
Cancel
Save