docs: Move files around

Keep the main docs (`readme/changelog/license` and rendered screencasts) in the root, and move the rest to `docs/`. The goal is to easily exclude developer-oriented files from the cargo package.
vincentdephily · Jun 23, 2023 · ae34e55 · ae34e55
1 parent 09ad01a
commit ae34e55
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
 /target/
-docs/*.cast
 benches/bench*.csv
 **/*.rs.bk
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ merge time prediction.
 
 It draws inspiration from [genlop](https://github.com/gentoo-perl/genlop) and
 [qlop](https://github.com/gentoo/portage-utils) but aims to be faster, more accurate, and more
-ergonomic, see [COMPARISON](COMPARISON.md).
+ergonomic, see [comparison](docs/COMPARISON.md).
 
 ## Usage
 
@@ -35,7 +35,7 @@ All commands share these arguments, affecting parsing and output:
 
 ### List merges, unmerges, and rsyncs  with `log`
 
-![Log demo](docs/log.webp)
+![Log demo](log.webp)
 
 Log-specific options:
 
@@ -48,7 +48,7 @@ Log-specific options:
 
 ### Estimate how long a merge with take with `predict`
 
-![Predict demo](docs/predict.webp)
+![Predict demo](predict.webp)
 
 Predict-specific arguments:
 
@@ -67,7 +67,7 @@ Predict-specific arguments:
 
 ### Show aggregated statistics with `stats`
 
-![Stats demo](docs/stats.webp)
+![Stats demo](stats.webp)
 
 Stats-specific arguments:
 
@@ -120,4 +120,4 @@ Install Rust and using [portage](https://wiki.gentoo.org/wiki/Rust) or
 
 ## Contributing
 
-Thanks in advance. See [CONTRIBUTING](CONTRIBUTING.md) for pointers. Emlop is licensed as GPLv3.
+Thanks in advance. See [contributing](docs/CONTRIBUTING.md) for pointers. Emlop is licensed as GPLv3.
diff --git a/COMPARISON.md → docs/COMPARISON.md b/COMPARISON.md → docs/COMPARISON.md
diff --git a/CONTRIBUTING.md → docs/CONTRIBUTING.md b/CONTRIBUTING.md → docs/CONTRIBUTING.md
@@ -43,6 +43,10 @@ unless the contributor explicitly demands otherwise.
 * Update/commit CHANGELOG.md, Cargo.toml, Cargo.lock.
 * `git tag <version> -a` (copy the changelog entry into the tag).
 * `git push --tags`.
+* Create release from tag in github
 * Create new ebuild in [moltonel-ebuilds](https://github.com/vincentdephily/moltonel-ebuilds).
+  - Use `cargo package` to get a crate to test
+  - Check against main repo ebuild
+  - Check tests and useflag variations
 * Publish to [crates.io](https://crates.io/).
 * Send a [bump request](https://bugs.gentoo.org/).
diff --git a/ROADMAP.md → docs/ROADMAP.md b/ROADMAP.md → docs/ROADMAP.md
diff --git a/docs/log.webp → log.webp b/docs/log.webp → log.webp
diff --git a/docs/predict.webp → predict.webp b/docs/predict.webp → predict.webp
diff --git a/docs/stats.webp → stats.webp b/docs/stats.webp → stats.webp