Add some disclaimers to the readme
This commit is contained in:
parent
bde7335465
commit
011ac99df8
1 changed files with 10 additions and 1 deletions
11
README.md
11
README.md
|
|
@ -2,12 +2,21 @@
|
||||||
This is the code and generation logic for my film recommendation blog.
|
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.
|
[See the site](https://caalden.github.io/film/) for a better idea of the content.
|
||||||
|
|
||||||
|
## Note to the public
|
||||||
|
I may have accidentally mischaracterized the extent to which I built the templating for this project. I conflated this
|
||||||
|
with a separate project I have (for generating my resume) where in I did build out the code that manages the templating
|
||||||
|
as well. In this case, I built out a bunch of custom layouts but hugo is doing the templating. Sorry for the accidental
|
||||||
|
misrepresentation.
|
||||||
|
|
||||||
|
Most of the notes in this README are for my own personal use. The `scripts/` directory is uncommitted as it contains
|
||||||
|
information that should not be committed publicly.
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
To publish updates to the blog, run
|
To publish updates to the blog, run
|
||||||
```bash
|
```bash
|
||||||
scripts/publish
|
scripts/publish
|
||||||
```
|
```
|
||||||
This will regenerate the files and stage the changes for commiting to git
|
This will regenerate the files and stage the changes for committing to git
|
||||||
|
|
||||||
## Authoring New Content
|
## Authoring New Content
|
||||||
To pull down information about a movie and generate the shell of a review, run:
|
To pull down information about a movie and generate the shell of a review, run:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue