Add a readme explaining basic usage

This commit is contained in:
Campbell Alden 2023-02-11 17:03:07 +09:00
parent 4ac895b0b1
commit ad8904e362

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# CaAlden: Films
This is the code and generation logic for my film recommendation blog.
[See the site](https://caalden.github.io/film/) for a better idea of the content.
## Publishing
To publish updates to the blog, run
```bash
scripts/publish
```
This will regenerate the files and stage the changes for commiting to git
## Authoring New Content
To pull down information about a movie and generate the shell of a review, run:
```bash
hugo new reviews/<title>.md
python scripts/bump_frontmatter.py reviews/<title>.md
```
where `<title>` is the name of the movie in kebab case.
The python script will fetch information from the open movie database
including ratings and poster images. It makes a best guess about links to other sites
but it's recommended that you confirm all generate content is valid
To view draft content run
```bash
hugo serve -D # -D includes draft content
```