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.

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

docs: add how to use via nixpkgs #387

Merged
merged 2 commits into from
Feb 20, 2025
+8 −0
Merged

docs: add how to use via nixpkgs #387

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b9bf4f
docs: add how to use via nixpkgs
kachick Feb 20, 2025
9345e82
docs: adjust badge position of repology
kachick Feb 20, 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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ If you don't have `rust` installed, we recommend installing it via [`rustup`](ht
(If you *are* interested in having a binary release, then please let us know in the 'Discussions' area of this
project or by filing a feature request in 'Issues'.)

[![Packaging status](https://repology.org/badge/vertical-allrepos/brush.svg)](https://repology.org/project/brush/versions)
Copy link
Owner

Choose a reason for hiding this comment

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

I'm a fan of repology; would be great to include the badge. Could you move the badge up with the rest of the badges near the top of the README? That will fit in well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! I have moved it with adding a blank line to fix mismatch of different badge height.

9345e82

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the link for other styles of badges we can choose. https://repology.org/project/brush/badges

Packaging status

Packaging status

latest packaged version(s)

nixpkgs unstable package

Copy link
Owner

Choose a reason for hiding this comment

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

Thanks for the info; the current badge looks fine for now.


If you are a Nix user, you can also use the registered version.

```bash
nix run 'github:NixOS/nixpkgs/nixpkgs-unstable#brush' -- --version
```

When you run `brush`, it should look exactly as `bash` would on your system since it processes `.bashrc` and
other usual configuration. If you'd like to customize the look of `brush` to distinguish it from the other shells
installed on your system, then you can also author a `~/.brushrc` file.
Expand Down