From b9c070b6c80154fb4e3a0cd7a346de3a08f722ea Mon Sep 17 00:00:00 2001 From: Fabrice Mouhartem Date: Sat, 15 Feb 2025 11:45:18 +0100 Subject: [PATCH] docs(readme): some info about building the blog --- readme.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/readme.md b/readme.md index 9f29f5c..9343ae4 100644 --- a/readme.md +++ b/readme.md @@ -1 +1,45 @@ +This repository contains the sources necessary to build the blog at: + +# Dependencies + +To use this repository as intended, you need, to build the blog, the following +software: + +- `git` +- `make` +- `uv` + +To synchronise the blog remotely with its intended target, the synchronisation +is done using `rsync` over `ssh`. + +# Install + +To install a local copy to work on this blog, you also need the theme for it, +available [there](https://git.epheme.re/fmouhart/pelican-clean-blog). It is +embedded in the repository as a git submodule, so you can simply run git clone +with the `--recurse-submodule` option: + +```sh +git clone -- recurse-submodule https://git.epheme.re/fmouhart/blog.git fmouhart-blog +``` + +This blog relies on [pelican](https://getpelican.com) as a static site +generator. To manage the different python dependencies of this project, we are +using [`uv`](https://github.com/astral-sh/uv) as a python project manager. + +To download the dependencies, run `uv sync` or: + +```sh +make init +``` + +# Development + +When writing an article, you can run the blog with livereload enabled with the command: + +```sh +make dev +``` + +It’ll span a local development server on port `8000`: