From 9b8ed0ef732bd0cfc0f16c0cdb0040bcff2936d5 Mon Sep 17 00:00:00 2001 From: Wei Zhang Date: Fri, 25 Aug 2023 14:18:10 +0800 Subject: :tada: :memo: update docs, release v1.0.0 Signed-off-by: Wei Zhang --- CHANGELOG.md | 7 ++++--- Cargo.lock | 2 +- Cargo.toml | 4 ++-- README.md | 36 ++++++++++++++++++------------------ 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5373c8..2594c4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 CI to build aarch64 macOS target and skip on test [#878](https://github.com/lsd-rs/lsd/pull/878) from [zwpaper](https://github.com/zwpaper) - Add complete color theming support for Git [k4yt3x](https://github.com/k4yt3x] @@ -391,8 +392,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 diff --git a/Cargo.lock b/Cargo.lock index 8f52306..614a722 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -542,7 +542,7 @@ dependencies = [ [[package]] name = "lsd" -version = "0.23.1" +version = "1.0.0" dependencies = [ "assert_cmd", "assert_fs", diff --git a/Cargo.toml b/Cargo.toml index 055bf8c..30fa892 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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]] diff --git a/README.md b/README.md index c5d65dc..4919254 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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, -- cgit v1.2.3