From b9ab07470f2513d9422581de1219ecb8683b513c Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Fri, 5 Aug 2022 22:58:07 +0800 Subject: Fix typos and markdowns See a detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md # Please enter the commit message for your changes. Lines starting --- contributing.md | 38 +++++++++++++++++++------------------- readme.md | 34 +++++++++++++++++----------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/contributing.md b/contributing.md index 795c007..0e63d0f 100644 --- a/contributing.md +++ b/contributing.md @@ -25,8 +25,8 @@ Branch off of `develop`. Bug fix branches should be named `feature/`. **Any hotfix or feature branch should only address one issue/feature**. -``` -$ git checkout -b develop +```sh +git checkout -b develop ``` ## Check The Test Suite @@ -34,9 +34,9 @@ $ git checkout -b develop Before making any changes, make sure that both the unit tests and the end-to-end tests all work. -``` -$ cargo test -$ test/e2e_test.sh +```sh +cargo test +test/e2e_test.sh ``` If you are planning on making changes that may affect performance, consider @@ -70,32 +70,32 @@ readme or any other relevant locations. Once you've finished your changes, make sure that your develop branch is up to date. -``` -$ git remote add upstream git@github.com:theryangeary/choose.git -$ git checkout develop -$ git pull upstream develop +```sh +git remote add upstream git@github.com:theryangeary/choose.git +git checkout develop +git pull upstream develop ``` Check that your code is all formatted correctly. If not, commit any changes. -``` -$ git checkout -$ cargo fmt -$ git status +```sh +git checkout +cargo fmt +git status ``` Rebase and squash your branch on develop. This will prompt you with a list of your commits. Change all but the first commit to "squash". Write a nice changelog message in the resulting commit. -``` -$ git rebase -i develop +```sh +git rebase -i develop ``` Push to your fork. -``` -$ git push --set-upstream origin +```sh +git push --set-upstream origin ``` Go to GitHub and [make a Pull @@ -111,6 +111,6 @@ commits. Each Pull Request will effectively be a single commit added to the After changing and committing, push like this: -``` -$ git push --force-with-lease +```sh +git push --force-with-lease ``` diff --git a/readme.md b/readme.md index d238e50..9d4b450 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,7 @@ This is `choose`, a human-friendly and fast alternative to `cut` and (sometimes) [![`choose` demo](https://asciinema.org/a/315932.png)](https://asciinema.org/a/315932?autoplay=1) ## Features + - terse field selection syntax similar to Python's list slices - negative indexing from end of line - optional start/end index @@ -107,10 +108,10 @@ find instructions [here](https://www.rust-lang.org/tools/install). Then, to install: ```bash -$ git clone https://github.com/theryangeary/choose.git -$ cd choose -$ cargo build --release -$ install target/release/choose +git clone https://github.com/theryangeary/choose.git +cd choose +cargo build --release +install target/release/choose ``` Just make sure DESTDIR is in your path. @@ -119,33 +120,33 @@ Just make sure DESTDIR is in your path. Cargo: -``` -$ cargo install choose +```sh +cargo install choose ``` Arch Linux: -``` -$ yay -S choose-rust-git +```sh +yay -S choose-rust-git ``` Fedora/CentOS [COPR](https://copr.fedorainfracloud.org/coprs/atim/choose/): -``` -$ dnf copr enable atim/choose -$ dnf install choose +```sh +dnf copr enable atim/choose +dnf install choose ``` Homebrew: -``` -$ brew install choose-rust +```sh +brew install choose-rust ``` MacPorts: -``` -$ sudo port install choose +```sh +sudo port install choose ``` ### Benchmarking @@ -157,7 +158,7 @@ that match the glob "long*txt". GitHub doesn't support files big enough in normal repos, but for reference the files I'm working with have lengths like these: -``` +```sh 1000 test/long.txt 19272 test/long_long.txt 96360 test/long_long_long.txt @@ -179,4 +180,3 @@ bore no ye of paid rent form. Old design are dinner better nearer silent excuse. She which are maids boy sense her shade. Considered reasonable we affronting on expression in. So cordial anxious mr delight. Shot his has must wish from sell ``` - -- cgit v1.2.3