crimsontome.com/README.md

45 lines
1.6 KiB
Markdown
Raw Normal View History

2021-10-20 15:33:11 +01:00
# CrimsonTome's Blog
2022-09-17 03:03:22 +01:00
2022-09-04 01:48:36 +01:00
> My personal blog documenting my journey into open-source development alongside other things.
2023-02-17 03:57:41 +00:00
> Created with Zola using the [terminimal theme](https://github.com/pawroman/zola-theme-terminimal), hosted on my VPS
2022-09-04 01:59:48 +01:00
2023-02-25 02:18:19 +00:00
![Repo Size](https://img.shields.io/github/repo-size/crimsontome/crimsontome.com)
![Commit Activity /month](https://img.shields.io/github/commit-activity/m/crimsontome/crimsontome.com)
![Last git commit](https://img.shields.io/github/last-commit/crimsontome/crimsontome.com)
2022-11-07 00:23:49 +00:00
2022-11-07 00:08:41 +00:00
- [CrimsonTome's Blog](#crimsontomes-blog)
- [Development](#development)
- [Building](#building)
2023-02-17 03:53:23 +00:00
- [Zola](#zola)
2022-11-07 00:08:41 +00:00
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
2022-11-07 00:23:49 +00:00
2022-09-04 01:48:36 +01:00
## Development
2021-10-20 02:25:45 +01:00
2022-09-17 03:03:22 +01:00
- clone the repo
2023-02-17 03:53:23 +00:00
- run `zola serve` when in `src/blog/`
2022-09-17 03:03:22 +01:00
- make some changes and watch them update in the browser
2022-09-04 01:48:36 +01:00
## Building
2021-10-15 23:02:37 +01:00
2023-02-17 03:53:23 +00:00
### Zola
2021-10-16 18:51:28 +01:00
2023-02-17 03:53:23 +00:00
- run `zola build` when in `src/blog` (this will only give the right site if your domain matches the base url, Zola is weird like that. serve will work fine)
2022-06-05 15:45:35 +01:00
2022-09-04 01:48:36 +01:00
2023-02-17 03:53:23 +00:00
. . Docker instructions may return in the future . .
2022-09-04 01:48:36 +01:00
## Contributing
2021-10-21 05:51:10 +01:00
2021-10-21 05:52:51 +01:00
See [CONTRIBUTING.md](CONTRIBUTING.md) for information on adding to this repository.
2022-09-04 01:48:36 +01:00
2022-11-07 00:08:41 +00:00
## Changelog
2022-11-07 00:23:49 +00:00
Run `./changelog` to generate the changelog after your commit, then `git add . && git commit --amend --no-edit ` to generate the changelog
The changelog is available [here](CHANGELOG)
2022-11-07 00:08:41 +00:00
2022-09-04 01:48:36 +01:00
## License
crimsontome.com is released under the MIT License. The full license text is included in the [LICENSE](LICENSE.md) file in this repository. Tldr legal have a [great summary](https://tldrlegal.com/license/mit-license) of the license if you're interested.