Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mummy likes better docs~ #41

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,85 @@ So if you set `CARGO_MOMMYS_ROLES="daddy"`, `CARGO_MOMMYS_PRONOUNS="his/their"`,

And so on~ 💓

<details>

<summary>
OS-specific information:
</summary>

### For macOS, Linux, BSD (or any sufficiently Unix-like operating system)

You're probably using [Zsh](https://zsh.sourceforge.io/) or [Bash](https://www.gnu.org/software/bash/) as your login shell, to check - open up a terminal window (Terminal.app or [iTerm2](https://github.com/gnachman/iTerm2) on macOS; [Console](https://gitlab.gnome.org/GNOME/console), [Terminal](https://gitlab.gnome.org/GNOME/gnome-terminal), [Konsole](https://github.com/KDE/konsole), [Kitty](https://github.com/kovidgoyal/kitty), or [Alacritty](https://github.com/alacritty/alacritty) most likely anywhere else) and run `echo $SHELL`.

You can see all of your current settings by running `export -p | grep CARGO_MOMMY`.

Depending on the one you have, you'll have to modify the contents of your rcfile (with [vim](https://github.com/vim/vim), [nano](https://nano-editor.org/), [helix](https://github.com/helix-editor/helix) etc.), or create one if it doesn't exist.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a little excessive to tell a rust programmer how to edit a text file. X3


- Bash:
Change `~/.bashrc` to include your settings. Set them with `export VAR_NAME=value`, for example:

```sh
$ cat ~/.bashrc
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably it would be simpler to just show the contents of the file once (since it's the same thing regardless of file). Also including the cat expression might be confusing (might make them think they should be adding that to the file).


export CARGO_MOMMYS_LITTLE="boy"
export CARGO_MOMMYS_ROLES="daddy"
export CARGO_MOMMYS_PRONOUNS="his"
export CARGO_MOMMYS_MOODS="yikes"
```

- Zsh:
Change `~/.zshenv`. Set them with `export VAR_NAME=value`, for example:

```sh
$ cat ~/.zshenv

export CARGO_MOMMYS_LITTLE="girlie"
export CARGO_MOMMYS_ROLES="momma"
export CARGO_MOMMYS_PRONOUNS="her/their"
export CARGO_MOMMYS_MOODS="chill/thirsty"
```

To remove any of the settings, simply delete the associated line in the file.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting that you call out bashrc and zshenv but not the most-generic ~/.profile. I know you sometimes HAVE to use those two files, but idk how many shells don't look at either but do look at ~/.profile. I do know fish doesn't look at any of the 3, making it the hardest to doc/support. X3


### For our dear Windows friends:

To check which settings you're currently using, open a Command Prompt or Powershell window (a quick way to do this is to press `Windows` + `X` on your keyboard), and type:

- For Command Prompt:

```sh
> set | find "CARGO_MOMMY"
```

- For Powershell (now might be a good time to learn the difference between Windows `powershell.exe` and Microsoft `pwsh.exe`):
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait is it? What's the difference they should know? I would have thought pwsh vs cmd would be a bigger concern.


```powershell
> Get-Item Env:\CARGO_MOMMY*
```

It's simultaneously easier and harder to set environment variables on Windows - soo many ways are available, but the easiest are:

- You can use the Control Panel by:
1. Going to Start,
2. Searching "path" and clicking the "Edit the system environment variables" option,
3. Then "Environment Variables",
4. And finally, "New" (or whichever button is appropriate) under the "User" section (the top one).

- If you happen to have modern Powershell (that's anything with the Microsoft branding/black logo/version 7+), you can run:

```powershell
> [Environment]::SetEnvironmentVariable("VAR_NAME", "value", "User")
```

to add one, and:

```powershell
> [Environment]::SetEnvironmentVariable("VAR_NAME", "", "User")
```

to remove it (by setting it to an empty string).

</details>

# Configuration (kink)

Expand Down