Skip to content

Commit 4cebb8c

Browse files
authored
Merge pull request #393 from cprice11/cprice11-bugfix-intro-spelling-grammar
Fixing some spelling
2 parents 571377f + 4ffc3e2 commit 4cebb8c

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

Diff for: share/intro.txt

+30-30
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ They are equivalent:
1212
{1curl https://}{2cht.sh}{1/tar}
1313
{1curl https://}{2cheat.sh}{1/tar}
1414

15-
The preferred access protocol is HTTPS, and you should use it always when possible.
15+
The preferred access protocol is HTTPS, and you should always use it when possible.
1616

1717
Cheat sheets in the root namespaces cover UNIX/Linux commands.
1818

@@ -24,7 +24,7 @@ All cheat sheets in a subsection can be listed using a special query {2:list} :
2424

2525
{1curl cht.sh/go/}{2:list}
2626

27-
There are several other special queries. All of them are starting with a {2colon}.
27+
There are several other special queries. All of them start with a {2colon}.
2828
See {2/:help} for the full list of the special queries.
2929

3030

@@ -36,8 +36,8 @@ search term will be displayed:
3636

3737
{1curl cht.sh/tar}{2~extract}
3838

39-
If the name of the cheat sheet is omitted, and only the serch query is specified,
40-
all cheat sheets in the namespace are scanned, and the found occurrencies
39+
If the name of the cheat sheet is omitted, and only the search query is specified,
40+
all cheat sheets in the namespace are scanned, and the found occurrences
4141
are displayed:
4242

4343
{1curl cht.sh/}{2~extract}
@@ -47,39 +47,39 @@ are displayed:
4747

4848
cheat.sh queries as well as search queries have many options.
4949
They can be specified as a part of the query string in the URL, after {2?}.
50-
Short single letter options could be written all jointly together,
51-
and long options are separated with {2&}. For example, to switch
52-
syntax highlighting off the {2T} switch is used:
50+
Short single letter options can be joined together. Long options are
51+
separated with {2&}. For example, to switch syntax highlighting off
52+
the {2T} switch is used:
5353

5454
{1curl cht.sh/tar}{2?T}
5555

56-
Full list of all available cheat.sh options as well as description of all modes
57-
of operation can be found in {2/:help},
56+
A full list of all available cheat.sh options as well as description of all modes
57+
of operation can be found in {2/:help}.
5858

5959
{1curl cht.sh}{2/:help}
6060

6161

6262
## cht.sh client
6363

6464
Though it's perfectly possible to access cheat.sh using {1curl} (or any other
65-
HTTP client) alone, there is a special client, that has several advantages
66-
comparing to plain curling: {2cht.sh}.
65+
HTTP client) alone, there is a special client that has several advantages
66+
over plain curling: {2cht.sh}.
6767

6868
To install the client in {2~/bin}:
6969

7070
{1curl} {2https://cht.sh/:cht.sh} {1> ~/bin/cht.sh}
7171
{1chmod +x ~/bin/cht.sh}
7272

73-
Queries look the same, but you can separate words in the query with {1spaces},
74-
instead of {1+} as when using curl, what looks more natural:
73+
Queries look the same, but you can use {1spaces} to separate words in addition to {1+}
74+
used with curl.
7575

7676
{1cht.sh} {2python zip lists}
7777

7878

7979
## cht.sh shell
8080

81-
If you always issuing queries about the same programming language, it's can be
82-
more convenient to run the client in the shell mode and specify the queries
81+
If you're always issuing queries about the same programming language, it can be
82+
more convenient to run the client in the shell mode and specify the query's
8383
context:
8484

8585
{1$} {2cht.sh --shell python}
@@ -92,7 +92,7 @@ Of course, you can start the shell without the context too:
9292
{1cht.sh> go http query}
9393
{1cht.sh> js iterate list}
9494

95-
If you use predominantly one language but sometime issuing queries about other,
95+
If you use one language predominantly, but sometimes issue queries about others,
9696
you may prepend the query with {2/}:
9797

9898
{1cht.sh/python>} {2zip lists}
@@ -102,11 +102,11 @@ you may prepend the query with {2/}:
102102

103103
## :learn
104104

105-
If you are just start learning a new programming language, and you have no
106-
distinct queries for the moment, cheat.sh can be a good starting point too. As
107-
you know, it exports cheat sheets from the best cheat sheet repositories, and
108-
one of them is {1Learn X in Y}, a repository of concise documentation devoted
109-
to learning programming languages from scratch (and not only them).
105+
If you are just starting to learn a new programming language and you have no
106+
distinct queries for the moment, cheat.sh can be a good starting point. As
107+
you know, it exports cheat sheets from the best cheat sheet repositories,
108+
like {1Learn X in Y}, a repository of concise documentation devoted
109+
(but not limited) to learning programming languages from scratch.
110110

111111
If you want start learning a new programming language, do (use less -R because
112112
the output could be quite big):
@@ -122,8 +122,8 @@ Or simply {2:learn} with cht.sh (you don't need {2less -R} here, because
122122
## Programming languages questions
123123

124124
One of the most important features of cheat.sh is that you can ask it any
125-
questions about programming languages and instantly get answers on them. You
126-
can use both direct HTTP queries or the cht.sh client for that:
125+
questions about programming languages and instantly get answers. You
126+
can use either direct HTTP queries or the cht.sh client:
127127

128128
{1curl cht.sh/}{2python/reverse+list}
129129

@@ -138,16 +138,16 @@ programming language name as the first word in the query:
138138
{4cht.sh>} {2python reverse list}
139139

140140
But if you are using only one programming language and all queries are about
141-
it, it's better to change the current context and
141+
it, it's better to change the current context.
142142

143143

144144
## Comments
145145

146-
Text in the answers is syntactically formatted as comment in the correspondent
146+
Text in the answers is syntactically formatted as a comment in the corresponding
147147
programming language
148148

149149
When using cht.sh, you can copy the result of the last query into the selection
150-
buffer (you may also call it "clibpoard") using {2C} (or {2c}, with text):
150+
buffer (you may also call it "clipboard") using {2C} (or {2c}, with text):
151151

152152
{1cht.sh/python> reverse list}
153153
{4...}
@@ -161,7 +161,7 @@ One of the advantages of the {1cht.sh} client comparing to plain curl is that yo
161161
can use TAB completion when writing its queries in {1bash}
162162
(other supported shells: {1zsh} and {1fish}).
163163

164-
Install the TAB completion script for that. Assuming you use bash, you have to do:
164+
To install the TAB completion script, assuming you use bash, you have to do:
165165

166166
{1mkdir -p ~/.bash.d/}
167167
{1curl} {2https://cht.sh/:bash_completion} {1> ~/.bash.d/cht.sh}
@@ -172,15 +172,15 @@ Install the TAB completion script for that. Assuming you use bash, you have to d
172172
## Editor
173173

174174
You can access cheat.sh directly from editors: {1Vim} and {1Emacs}.
175-
It's a very important feature! You should absolutely like it.
175+
It's a very important feature! You will absolutely like it.
176176

177177
{1Imagine:}
178178
instead of switching to your browser, googling, browsing Stack Overflow
179179
and eventually copying the code snippets you need and later pasting them into
180180
the editor, you can achieve the same instantly and without leaving
181181
the editor at all!
182182

183-
Here is how it looks like:
183+
Here is how it works:
184184

185185
1. In Vim, if you have a question while editing a program, you can just type
186186
your question {1directly in the buffer} and press {2<leader>KK}. You will get
@@ -194,7 +194,7 @@ answer without the comments, {2<leader>KC} replays the last query
194194
toggling them.
195195

196196
You have to install cheat.sh {1Vim/Emacs plugins} for the editor support.
197-
See {2/:vim} or {2/:emacs} with the detailed installation instructions.
197+
See {2/:vim} or {2/:emacs} for detailed installation instructions.
198198

199199

200200
## Feature requests, feedback and contribution

0 commit comments

Comments
 (0)