diff --git a/.mise.toml b/.mise.toml new file mode 100644 index 0000000..350f455 --- /dev/null +++ b/.mise.toml @@ -0,0 +1,8 @@ +[tools] +python = { version = "3.11", virtualenv = ".venv" } +markdownlint-cli2 = "latest" +pdm = "latest" + +[plugins] +pdm = "https://github.com/1oglop1/asdf-pdm" +markdownlint-cli2 = "https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2" diff --git a/.rtx.toml b/.rtx.toml deleted file mode 100644 index 605d087..0000000 --- a/.rtx.toml +++ /dev/null @@ -1,3 +0,0 @@ -[tools] -python = { version = "3.11", virtualenv = ".venv" } -markdownlint-cli2 = "latest" diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..dcdf992 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,5 @@ +# Install/Build the Book + +The repo is set up to use [mise](https://mise.jdx.dev) to install required tools. Once `mise` is installed, changing into this directory should install the correct tools with the right versions. + +After that, running `pdm install` should install the dependencies. Then `doit build_jb` will build the book. diff --git a/_config.yml b/_config.yml index a243cd5..2b304ae 100644 --- a/_config.yml +++ b/_config.yml @@ -12,6 +12,7 @@ exclude_patterns: - chapter-4 - .venv - .pytest_cache + - INSTALL.md latex: latex_engine: xelatex