Skip to content

Add Starship to README.md #135

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.

Sign up for GitHub

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

Merged
fwdekker merged 7 commits into from
Feb 1, 2025
Merged

Add Starship to README.md #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
78fa5ef
Adding a starship section to shell config in the README.
ninetailedtori Feb 1, 2025
6aea08a
Add starship.png
ninetailedtori Feb 1, 2025
0c96840
Add picture to starship section of README.
ninetailedtori Feb 1, 2025
d7d071a
Delete .github/img/starship.png
ninetailedtori Feb 1, 2025
03ee7ff
Adding a good image to images.
ninetailedtori Feb 1, 2025
13d0672
Update README.md
ninetailedtori Feb 1, 2025
7aa2dcd
Update README.md
ninetailedtori Feb 1, 2025
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
Binary file added .github/img/starship.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,27 @@ finally, the `%f` in the suffix resets the colors~
<img width="450px" src=".github/img/zsh.png" alt="zsh showing the text 'never give up, my love' in the right prompt after running a command that has failed" />
</details>

<details>
<summary>🚀 Starship</summary>

When using Starship for `oh-my-posh`-like prompts (supporting many shells like `bash`, `zsh` and `fish`), you can change the prompt itself to
contain a message from mommy by generating a custom `mommy` module in your `.config/starship.toml` file:
```toml
# Writing a custom module for mommy O_o
[custom.mommy]
command = "mommy -1 -s $status"
when = "true"
```
You can place this anywhere in your Starship arrangements. The above code uses the mommy command from fish, however you can replace it with any of the mommy commands listed for another shell, when using it with another shell.

For example, use this to have mommy appear on your right prompt at all times~
```toml
right_format = "$custom"
```

<img width="450px" src=".github/img/starship.png" alt="starship with a left prompt with modules, and a right prompt with the custom mommy module, saying things like '*pets your head*' with empty commands." />
</details>

<details>
<summary>🐌 other shells</summary>

Expand Down