Skip to content

Commit

Permalink
🎉 📝 update docs, release v1.0.0
Browse files Browse the repository at this point in the history 
Signed-off-by: Wei Zhang <[email protected]>
  • Loading branch information
@zwpaper
zwpaper committed Aug 25, 2023
1 parent 8acaabe commit 2efc5cf
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 25 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [v1.0.0] - 2023-08-25

### Added
- Add complete color theming support for Git [k4yt3x](https://github.com/k4yt3x]
- Add [Git integration](https://github.com/Peltoche/lsd/issues/7) from [hpwxf](https://github.com/hpwxf)
Expand Down Expand Up @@ -36,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Color theme is now expected to be in `$XDG/lsd/colors.yaml` by default from [peppidesu](https://github.com/peppidesu)
Legacy behaviour (`themes` folder) is marked as deprecated but is still supported.
[#749](https://github.com/lsd-rs/lsd/issues/749)
- Version sort option `-v, --versionsort` has been updated to match GNU version sort logic,
- Version sort option `-v, --versionsort` has been updated to match GNU version sort logic,
similar to `ls -v` and `sort -V` [#801](https://github.com/lsd-rs/lsd/issues/801) from [juansc](https://github.com/juansc)

## [0.23.1] - 2022-09-13
Expand Down Expand Up @@ -390,8 +391,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0



[Unreleased]: https://github.com/Peltoche/lsd/compare/0.23.1...HEAD
[0.23.1]: https://github.com/Peltoche/lsd/compare/0.23.0...0.23.1
[v1.0.0]: https://github.com/lsd-rs/lsd/compare/0.23.1...v1.0.0
[0.23.1]: https://github.com/Peltoche/lsd/compare/0.23.0...0.23.1
[0.23.0]: https://github.com/Peltoche/lsd/compare/0.22.0...0.23.0
[0.22.0]: https://github.com/Peltoche/lsd/compare/0.21.0...0.22.0
[0.21.0]: https://github.com/Peltoche/lsd/compare/0.20.1...0.21.0
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ keywords = ["ls"]
license = "Apache-2.0"
name = "lsd"
readme = "./README.md"
repository = "https://github.com/Peltoche/lsd"
version = "0.23.1"
repository = "https://github.com/lsd-rs/lsd"
version = "1.0.0"
edition = "2021"

[[bin]]
Expand Down
36 changes: 18 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@ The project is heavily inspired by the super [colorls](https://github.com/athity

Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions. Don't forget to setup your terminal in order to use the correct font.

| OS/Distro | Command |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Archlinux | `pacman -S lsd` |
| Fedora | `dnf install lsd` |
| Gentoo | `sudo emerge sys-apps/lsd` |
| macOS | `brew install lsd` or `sudo port install lsd` |
| NixOS | `nix-env -iA nixos.lsd` |
| FreeBSD | `pkg install lsd` |
| NetBSD or any `pkgsrc` platform | `pkgin install lsd` or `cd /usr/pkgsrc/sysutils/lsd && make install` |
| Windows | `scoop install lsd` |
| Android (via Termux) | `pkg install lsd` |
| Debian sid and bookworm | `apt install lsd` |
| Ubuntu 23.04 (Lunar Lobster) | `apt install lsd` |
| Earlier Ubuntu/Debian versions | **snap discontinued**, use `sudo dpkg -i lsd_0.23.1_amd64.deb` and get `.deb` file from [release page](https://github.com/Peltoche/lsd/releases) |
| Solus | `eopkg it lsd` |
| Void Linux | `sudo xbps-install lsd` |
| openSUSE | `sudo zypper install lsd` |
| OS/Distro | Command |
|---------------------------------|----------------------------------------------------------------------|
| Archlinux | `pacman -S lsd` |
| Fedora | `dnf install lsd` |
| Gentoo | `sudo emerge sys-apps/lsd` |
| macOS | `brew install lsd` or `sudo port install lsd` |
| NixOS | `nix-env -iA nixos.lsd` |
| FreeBSD | `pkg install lsd` |
| NetBSD or any `pkgsrc` platform | `pkgin install lsd` or `cd /usr/pkgsrc/sysutils/lsd && make install` |
| Windows | `scoop install lsd` |
| Android (via Termux) | `pkg install lsd` |
| Debian sid and bookworm | `apt install lsd` |
| Ubuntu 23.04 (Lunar Lobster) | `apt install lsd` |
| Earlier Ubuntu/Debian versions | **snap discontinued**, use [From Binaries](#from-binaries) |
| Solus | `eopkg it lsd` |
| Void Linux | `sudo xbps-install lsd` |
| openSUSE | `sudo zypper install lsd` |

### From source

Expand Down Expand Up @@ -244,7 +244,7 @@ The valid theme configurations are:
- `custom`: use a custom color scheme defined in `colors.yaml`
- *(deprecated) theme_file_name(yaml): use the theme file to specify colors(without the `yaml` extension)*

When set to `custom`, `lsd` will look for `colors.yaml` in the
When set to `custom`, `lsd` will look for `colors.yaml` in the
XDG Base Directory, e.g. ~/.config/lsd/colors.yaml

When configured with the `theme-file-name` which is a `yaml` file,
Expand Down

0 comments on commit 2efc5cf

Please sign in to comment.