Add install instructions. Switch to mise configuration from rtx (#20)

* Add install instructions. Switch to mise configuration from rtx * Ignore INSTALL.md from book
bryanwweber · Jan 27, 2024 · 5701f56 · 5701f56
1 parent 280ebec
commit 5701f56
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/.mise.toml 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
diff --git a/INSTALL.md 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
@@ -12,6 +12,7 @@ exclude_patterns:
  - chapter-4
  - .venv
  - .pytest_cache
+ - INSTALL.md
 
 latex:
  latex_engine: xelatex