book: add requirements in README.md

Replace `Makefile` with `justfile`
rust-nostr · Jan 16, 2024 · 6d3fcda · 6d3fcda
1 parent ff89f77
commit 6d3fcda
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 13 deletions.
diff --git a/book/.gitignore b/book/.gitignore
@@ -1 +1 @@
-book
+book/
diff --git a/book/Makefile b/book/Makefile
diff --git a/book/README.md b/book/README.md
@@ -2,14 +2,24 @@
 
 ## Developers
 
+### Requirements
+
+* [Just](https://github.com/casey/just): install with `cargo install just`
+
 Init
 
 ```bash
-make init
+just init
 ```
 
 You can serve the site with:
 
 ```bash
-make serve
+just serve
+```
+
+To test all the snippets:
+
+```bash
+just test
 ```
diff --git a/book/book.toml b/book/book.toml
@@ -12,7 +12,6 @@ preferred-dark-theme = "ayu"
 additional-js = ["./tabs.js"]
 additional-css = ["./mdbook-admonish.css"]
 git-repository-url = "https://github.com/rust-nostr/nostr"
-edit-url-template = "https://github.com/rust-nostr/nostr/edit/master/{path}"
 
 [preprocessor]
 

diff --git a/book/justfile b/book/justfile
@@ -1,2 +1,12 @@
+init:
+	cargo install mdbook --version 0.4.36
+	cargo install mdbook-admonish --version 1.15.0
+
+build:
+	mdbook build
+
+serve:
+	mdbook serve
+
 test:
 	cd snippets && just test