From 926ad466f16400e9188b444077511f5881b54ac1 Mon Sep 17 00:00:00 2001 From: Michael Floering Date: Tue, 16 Feb 2021 12:23:01 -0800 Subject: [PATCH 1/3] README - small changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add link to jump to installation section - Add link to jump to installing tab completion. Named this link "auto-complete" so that "auto" and "complete" (ending with an -e rather than -ion) would both show up when grepped/ ⌘+F Why: - Less intimidating to newcomers — I've just observed that friends/colleagues adopt tldr rather than cheat.sh soley because they didn't see the "get started" stuff up top. So they missed it. - Faster to "just install it" when you know you're going to do that anyways. i.e. from a friend recommending. or on a new machine. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 652906b..51448e4 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ What features should it have? * **Tutoring** — It should help you to learn the subject. * **Inconspicuous** — It should be possible to use it completely unnoticed. -Such a thing exists. +Such a thing exists! It's easy to [install](#installation) and there's even [auto-complete](#tab-completion). ## Features From 815df01c7d9c43681ea089095dbea845c59dbc5d Mon Sep 17 00:00:00 2001 From: Michael Floering Date: Tue, 16 Feb 2021 12:31:52 -0800 Subject: [PATCH 2/3] README - small changes - add some horizontal-rules Helps with visual scannability when scrolling down the page --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 51448e4..36c4ff5 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,8 @@ Try your own queries. Follow these rules: Read more about the programming languages queries below. +---- + ## Command line client, cht.sh The cheat.sh service has its own command line client (`cht.sh`) that @@ -342,6 +344,8 @@ To activate tab completion support for `cht.sh`, add the `:zsh` script to the *f $ # Open a new shell to load the plugin ``` +---- + ### Stealth mode Being used fully unnoticed is one of the most important property of any cheat sheet. @@ -442,6 +446,8 @@ You can also use [`scoop`](https://github.com/lukesampson/scoop) command-line in scoop install cht ``` +---- + ## Self-Hosting ### Docker From 09811e64c6cb31ca27885d32a8e03249531d1a77 Mon Sep 17 00:00:00 2001 From: Michael Floering Date: Tue, 16 Feb 2021 12:35:10 -0800 Subject: [PATCH 3/3] README - small changes - for those newer to sh This is something we take for granted but newcomers to sh, Linux, and so on. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 36c4ff5..246c891 100644 --- a/README.md +++ b/README.md @@ -205,9 +205,10 @@ has several useful features compared to querying the service directly with `curl To install the client: ``` - mkdir -p ~/bin/ - curl https://cht.sh/:cht.sh > ~/bin/cht.sh - chmod +x ~/bin/cht.sh + PATH_DIR="$HOME/bin" # or another directory on your $PATH + mkdir -p "$PATH_DIR" + curl https://cht.sh/:cht.sh > "$PATH_DIR/cht.sh" + chmod +x "$PATH_DIR/cht.sh" ``` or to install it globally (for all users):