Gankra · Gankra · Nov 20, 2023 · Nov 19, 2023 · Nov 19, 2023 · Nov 19, 2023
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /target
-
 # Generated by `oranda generate ci`
-public/
+public/
+# Generated by mdbook
+book/book/
diff --git a/README.md b/README.md
@@ -8,61 +8,34 @@
 [![Rust CI](https://github.com/Gankra/cargo-mommy/workflows/Rust/badge.svg?branch=main)](https://github.com/Gankra/cargo-mommy/actions/workflows/ci.yml)
 
 
+
 Mommy's here to support you when running cargo~ ❤️
 
 # Installation
 
-Install cargo-mommy like you would any other cargo extension~
+You can `cargo install cargo-mommy`, [see the website for more options](https://faultlore.com/cargo-mommy/)
 
-```text
-> cargo install cargo-mommy
-```
 
 # Usage
 
 Run whatever cargo command you would normally but add mommy after cargo~
 
-```text
-> cargo mommy test
-
-    Finished test [unoptimized + debuginfo] target(s) in 0.00s
-     Running unittests src\main.rs (target\debug\deps\cargo_mommy-3804b5c850d46137.exe)
-
-running 1 test
-test test ... FAILED
-
-failures:
-
----- test stdout ----
-thread 'test' panicked at 'oops!!', src\main.rs:26:5
-note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
-
-
-failures:
-    test
-
-test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
-
-error: test failed, to rerun pass `--bin cargo-mommy`
-
-mommy knows her little girl can do better~ ❤️
-
->_
 ```
+cargo mommy check
 
-If you try to make it into an alias, you should prefer pointing it to `cargo-mommy` directly,
-we wouldn't want to break the rustup toolchain picker, now would we?~
+    Checking bappy-script v0.1.3
+error: expected one of `!` or `::`, found `passes`
+  --> src\main.rs:20:6
+   |
+20 | mods passes;
+   |      ^^^^^^ expected one of `!` or `::`
 
-If you want to use `cargo-mommy` for not-cargo programs, just set the `CARGO_{ROLE}S_ACTUAL`
-environment variable to it, for example
-
-```
-$ CARGO_MOMMYS_ACTUAL=date ./target/debug/cargo-mommy
-Sun Nov 19 05:33:34 PM CET 2023
-what a good girl you are~
+error: could not compile `bappy-script` (bin "bappy-script") due to previous error
+mommy knows her little girl can do better~ 💞
 ```
 
-mommy will also respect `CARGO` to execute the right cargo for you~
+[See the docs for more options](https://faultlore.com/cargo-mommy/book/)
+
 
 # Configuration
 
@@ -87,60 +60,7 @@ So if you set `CARGO_MOMMYS_ROLES="daddy"`, `CARGO_MOMMYS_PRONOUNS="his/their"`,
 And so on~ 💓
 
 
-# Configuration (kink)
-
-<details>
-
-<summary>
-<b>THIS IS NSFW, STOP READING IF YOU WANT MOMMY TO REMAIN INNOCENT!</b>
-</summary>
-
-...
-
-...
-
-Good pet~ ❤️
-
-All of mommy's NSFW content is hidden behind CARGO_MOMMYS_MOODS, where "thirsty" is heavy teasing/flirting and "yikes" is full harsh dommy mommy kink~
-
-You can enable "true mommy chaos mode" by setting `CARGO_MOMMYS_MOODS="chill/ominous/thirsty/yikes"`, making mommy oscillate wildly between light positive affirmation and trying to break you in half~
-
-* `CARGO_MOMMYS_MOODS` - how kinky mommy will be~ (default: "chill", possible values "chill", "ominous", "thirsty", "yikes")
-* `CARGO_MOMMYS_PARTS` - what part of mommy you should crave~ (default: "milk")
-* `CARGO_MOMMYS_FUCKING` - what to call mommy's pet~ (default: "slut/toy/pet/pervert/whore")
-
------
-
-**Here's some examples of mommy being thirsty~ ❤️**
-
-*tugs your leash*
-that's a VERY good girl~ 💞
-
-*smooches your forehead*
-good job~
-
-are you just keysmashing now~?
-cute~ 💖
-
-if you don't learn how to code better, mommy is going to put you in time-out~ 💓
-
------
-
-**And here's some examples of mommy being yikes~ 💞**
-
-good slut~
-you've earned five minutes with the buzzy wand~ 💗
-
-*slides her finger in your mouth*
-that's a good little toy~ ❤️
-
-get on your knees and beg mommy for forgiveness you pervert~
-
-mommy is starting to wonder if you should just give up and become her breeding stock~ 💗
-
-</details>
 
--------
 
 
 # Licensing

diff --git a/book/book.toml b/book/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Aria Beingessner"]
+language = "en"
+multilingual = false
+src = "src"
+title = "cargo-mommy"
diff --git a/book/src/README.md b/book/src/README.md
@@ -0,0 +1,31 @@
+# Introduction
+
+Mommy's here to support you when running cargo~ ❤️
+
+[See the homepage for installation instructions~](https://faultlore.com/cargo-mommy/)
+
+Run whatever cargo command you would normally but add mommy after cargo~
+
+```
+cargo mommy check
+
+    Checking bappy-script v0.1.3
+error: expected one of `!` or `::`, found `passes`
+  --> src\main.rs:20:6
+   |
+20 | mods passes;
+   |      ^^^^^^ expected one of `!` or `::`
+
+error: could not compile `bappy-script` (bin "bappy-script") due to previous error
+mommy knows her little girl can do better~ 💞
+```
+
+By default mommy is kind to her little girl, but she can become anything you want~
+
+* [I want mommy to call myself or herself something else](./customize/roles-and-pronouns.md)
+* [I want `cargo mommy` to be `cargo daddy` (or anything else)](./customize/true-roles.md)
+* [I want mommy to work with our plurality](./customize/true-roles.md)
+* [I want mommy to have a totally different mood](./customize/moods.md)
+* [I want mommy to invoke mommy with more than cargo](./customize/not-just-cargo.md)
+* [I want mommy to sdsdfdsfdfsd me (enabling nsfw features)](./customize/nsfw.md)
+* [I never want mommy to sdsdfdsfdfsd me (compiling out all nsfw features)](./customize/never-nsfw.md)
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -0,0 +1,22 @@
+# Summary
+
+- [Introduction](./README.md)
+- [Customizing](./customize/README.md)
+    - [Roles And Pronouns](./customize/roles-and-pronouns.md)
+    - [Moods](./customize/moods.md)
+    - [True Roles](./customize/true-roles.md)
+    - [Not Just Cargo](./customize/not-just-cargo.md)
+    - [NSFW Features](./customize/nsfw.md)
+    - [Removing NSFW Features](./customize/never-nsfw.md)
+- [Guides](./guides/README.md)
+    - [Powershell (Windows)](./guides/powershell.md)
+    - [Bash](./guides/bash.md)
+    - [CI](./guides/ci.md)
+- [Contributing](./contributing/README.md)
+    - [Concepts](./contributing/concepts.md)
+    - [Adding New Messages](./contributing/adding-messages.md)
+    - [Adding A New Variable](./contributing/adding-variables.md)
+    - [Adding A New Mood](./contributing/adding-moods.md)
+    - [Locally Building The Website](./contributing/docs.md)
+    - [Releasing](./contributing/releasing.md)
+
diff --git a/book/src/contributing/README.md b/book/src/contributing/README.md
@@ -0,0 +1,24 @@
+# Contributing
+
+These are the technical rules of mommy club~
+
+* mommy as a project is always going to *default* to being mommy, and *default* to loving her little girl, even if she also does everything she can to be customizable for people who don't want that~ 💖
+* there is no such thing as "being too extra" about mommy, mommy is so very overengineered and that is wonderful~ 💖
+* mommy is sfw and kind first and foremost, keep the hard stuff in [its corner](../customize/nsfw.md)~ 🖤
+    * `--no-default-features` *has* to [make mommy forget how to be nsfw](../customize/never-nsfw.md)~
+* if you add a feature, make sure it respects mommy's [True Roles](../customize/true-roles.md)~
+* mommy should try her best to make sure the underlying commands she invokes work correctly~
+* if mommy's functionality *can* be driven by [responses.json](https://github.com/Gankra/cargo-mommy/blob/main/responses.json), it should be~
+* commit messages and comments should ideally be in mommy's voice but sometimes that's exhausting to sustain for complex technical details so this is not enforced, just encouraged~ 💕
+
+These are the social rules of mommy club~
+
+* mommy loves you~ ❤️
+* you should be kind to others~ 💖
+* Gankra is the arbiter of the previous detail until further notice~ 💙
+
+For most contributions, you probably just need to [edit responses.json](https://github.com/Gankra/cargo-mommy/blob/main/responses.json)~
+
+See the sub-pages for details~
+
+
diff --git a/book/src/contributing/adding-messages.md b/book/src/contributing/adding-messages.md
@@ -0,0 +1,5 @@
+# Adding New Messages
+
+If you want to add a new message to an existing mood, all you need to do is edit [repsonses.json](https://github.com/Gankra/cargo-mommy/blob/main/responses.json) and add the string! See [the concepts docs for details on the format](./concepts.md)~
+
+That's it, no code or docs needs to be changed~ 💕
diff --git a/book/src/contributing/adding-moods.md b/book/src/contributing/adding-moods.md
@@ -0,0 +1,38 @@
+# Adding A New Mood
+
+You shouldn't need any code to add a mood, just update [responses.json](https://github.com/Gankra/cargo-mommy/blob/main/responses.json) and the docs~
+
+## Editing responses.json
+
+* Add [the new mood to responses.json's "moods" object](./concepts.md#responsesjson)~
+* Fill in as many messages as you can think of for [the message pools](./concepts.md#message-pools)~
+* If NSFW, be sure to set "spiciness"~
+
+For instance, here's a minimal example (SFW) "sleepy" mood~ 💤
+
+```json
+{
+    "moods": {
+        "sleepy": {
+            "positive": [
+                "that almost makes {role} want to get out of bed...",
+                "*yawns*\ngood work~"
+            ],
+            "negative": [
+                "{role} thinks {pronoun} little {affectionate_term} might also be too tired~",
+                "let's just take a nap, ok~?"
+            ],
+            "overflow": [
+                "{role} did too much and is going to bed..."
+            ]
+        },
+    }
+}
+```
+
+That's it, no code needs to be changed!
+
+
+## Updating The Docs
+
+Add the mood and some example outputs to the [SFW mood docs](../customize/moods.md) or the [NSFW mood docs](../customize/nsfw.md#moods).
diff --git a/book/src/contributing/adding-variables.md b/book/src/contributing/adding-variables.md
@@ -0,0 +1,47 @@
+# Adding A New Variable
+
+You shouldn't need any code to add a new variable, just update [responses.json](https://github.com/Gankra/cargo-mommy/blob/main/responses.json) and the docs~
+
+
+## Editing responses.json
+
+* Add [the new variable to responses.json's "vars" object](./concepts.md#responsesjson)~
+* Fill in [the default values](./concepts.md#variables)~
+* If NSFW, be sure to set "spiciness"~
+* Use the variable in [existing or new messages](./concepts.md#variables)~
+
+For instance, here's a minimal example "furniture" variable that is set with `CARGO_MOMMYS_FURNITURES`~ 🪑
+
+```json
+{
+    "vars": {
+        "furniture": {
+            "defaults": ["chair", "desk"]
+        },
+    }
+}
+```
+
+and here's how you might use it~
+
+```json
+{
+    "moods": {
+        "chill": {
+            "positive": [
+                "thanks for helping build {role}'s {furniture}~"
+            ],
+            "negative": [
+                "ouch! {role} stubbed {pronoun} toe on the {furniture}!"
+            ]
+        }
+    }
+}
+```
+
+That's it, no code needs to be changed~ 💕
+
+
+## Updating The Docs
+
+Add the variable to the [SFW variable docs](../customize/roles-and-pronouns.md.md) or the [NSFW variable docs](../customize/nsfw.md#variables).