@@ -12,7 +12,7 @@ They are equivalent:
12
12
{1curl https://}{2cht.sh}{1/tar}
13
13
{1curl https://}{2cheat.sh}{1/tar}
14
14
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.
16
16
17
17
Cheat sheets in the root namespaces cover UNIX/Linux commands.
18
18
@@ -24,7 +24,7 @@ All cheat sheets in a subsection can be listed using a special query {2:list} :
24
24
25
25
{1curl cht.sh/go/}{2:list}
26
26
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}.
28
28
See {2/:help} for the full list of the special queries.
29
29
30
30
@@ -36,8 +36,8 @@ search term will be displayed:
36
36
37
37
{1curl cht.sh/tar}{2~extract}
38
38
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
41
41
are displayed:
42
42
43
43
{1curl cht.sh/}{2~extract}
@@ -47,39 +47,39 @@ are displayed:
47
47
48
48
cheat.sh queries as well as search queries have many options.
49
49
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:
53
53
54
54
{1curl cht.sh/tar}{2?T}
55
55
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}.
58
58
59
59
{1curl cht.sh}{2/:help}
60
60
61
61
62
62
## cht.sh client
63
63
64
64
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}.
67
67
68
68
To install the client in {2~/bin}:
69
69
70
70
{1curl} {2https://cht.sh/:cht.sh} {1> ~/bin/cht.sh}
71
71
{1chmod +x ~/bin/cht.sh}
72
72
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.
75
75
76
76
{1cht.sh} {2python zip lists}
77
77
78
78
79
79
## cht.sh shell
80
80
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
83
83
context:
84
84
85
85
{1$} {2cht.sh --shell python}
@@ -92,7 +92,7 @@ Of course, you can start the shell without the context too:
92
92
{1cht.sh> go http query}
93
93
{1cht.sh> js iterate list}
94
94
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 ,
96
96
you may prepend the query with {2/}:
97
97
98
98
{1cht.sh/python>} {2zip lists}
@@ -102,11 +102,11 @@ you may prepend the query with {2/}:
102
102
103
103
## :learn
104
104
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.
110
110
111
111
If you want start learning a new programming language, do (use less -R because
112
112
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
122
122
## Programming languages questions
123
123
124
124
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:
127
127
128
128
{1curl cht.sh/}{2python/reverse+list}
129
129
@@ -138,16 +138,16 @@ programming language name as the first word in the query:
138
138
{4cht.sh>} {2python reverse list}
139
139
140
140
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.
142
142
143
143
144
144
## Comments
145
145
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
147
147
programming language
148
148
149
149
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):
151
151
152
152
{1cht.sh/python> reverse list}
153
153
{4...}
@@ -161,7 +161,7 @@ One of the advantages of the {1cht.sh} client comparing to plain curl is that yo
161
161
can use TAB completion when writing its queries in {1bash}
162
162
(other supported shells: {1zsh} and {1fish}).
163
163
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:
165
165
166
166
{1mkdir -p ~/.bash.d/}
167
167
{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
172
172
## Editor
173
173
174
174
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.
176
176
177
177
{1Imagine:}
178
178
instead of switching to your browser, googling, browsing Stack Overflow
179
179
and eventually copying the code snippets you need and later pasting them into
180
180
the editor, you can achieve the same instantly and without leaving
181
181
the editor at all!
182
182
183
- Here is how it looks like :
183
+ Here is how it works :
184
184
185
185
1. In Vim, if you have a question while editing a program, you can just type
186
186
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
194
194
toggling them.
195
195
196
196
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.
198
198
199
199
200
200
## Feature requests, feedback and contribution
0 commit comments