Skip to content

Commit b9cebf9

Browse files
committed
docs: replace the unicode zero length characters with asterisks to be compatible with man page generated with ronn and make it easier to edit the README.md
Removing the unicode makes editing it easier. However, ronn has some issues with Markdown to man page format. For example, adding colons to the end of a bulleted line may disable bullets for the whole section.
1 parent 6ec0a68 commit b9cebf9

File tree

2 files changed

+25
-29
lines changed

2 files changed

+25
-29
lines changed

README.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,84 +8,82 @@ upload content to https://gist.github.com/.
88

99
## Installation
1010

11-
If you have ruby installed:
11+
* If you have ruby installed:
1212

1313
gem install gist
1414

15-
If you're using Bundler:
15+
* If you're using Bundler:
1616

1717
source :rubygems
1818
gem 'gist'
1919

20-
For OS X, gist lives in Homebrew
20+
* For OS X, `gist` lives in Homebrew
2121

2222
brew install gist
2323

24-
For FreeBSD, gist lives in ports
24+
* For FreeBSD, `gist` lives in ports
2525

2626
pkg install gist
2727

28-
For Ubuntu/Debian
28+
* For Ubuntu/Debian, `gist` has been renamed to `gist-paste` to avoid a name conflict
2929

3030
apt install gist
3131

32-
Note: Debian renames the binary to `gist-paste` to avoid a name conflict.
33-
3432
## Command
3533

36-
To upload the contents of `a.rb` just:
34+
* To upload the contents of `a.rb` just:
3735

3836
gist a.rb
3937

40-
Upload multiple files:
38+
* Upload multiple files:
4139

4240
gist a b c
4341
gist *.rb
4442

45-
By default it reads from STDIN, and you can set a filename with `-f`.
43+
* By default it reads from STDIN, and you can set a filename with `-f`.
4644

4745
gist -f test.rb <a.rb
4846

49-
Alternatively, you can just paste from the clipboard:
47+
* Alternatively, you can just paste from the clipboard:
5048

5149
gist -P
5250

53-
Use `-p` to make the gist private:
51+
* Use `-p` to make the gist private:
5452

5553
gist -p a.rb
5654

57-
Use `-d` to add a description:
55+
* Use `-d` to add a description:
5856

5957
gist -d "Random rbx bug" a.rb
6058

61-
You can update existing gists with `-u`:
59+
* You can update existing gists with `-u`:
6260

6361
gist -u GIST_ID FILE_NAME
6462
gist -u 42f2c239d2eb57299408 test.txt
6563

66-
If you'd like to copy the resulting URL to your clipboard, use `-c`.
64+
* If you'd like to copy the resulting URL to your clipboard, use `-c`.
6765

6866
gist -c <a.rb
6967

70-
If you'd like to copy the resulting embeddable URL to your clipboard, use `-e`.
68+
* If you'd like to copy the resulting embeddable URL to your clipboard, use `-e`.
7169

7270
gist -e <a.rb
7371

74-
And you can just ask gist to open a browser window directly with `-o`.
72+
* And you can just ask gist to open a browser window directly with `-o`.
7573

7674
gist -o <a.rb
7775

78-
To list (public gists or all gists for authed user) gists for user
76+
* To list (public gists or all gists for authed user) gists for user
7977

8078
gist -l : all gists for authed user
8179
gist -l defunkt : list defunkt's public gists
8280

83-
To read a gist and print it to STDOUT
81+
* To read a gist and print it to STDOUT
8482

8583
gist -r GIST_ID
8684
gist -r 374130
8785

88-
See `gist --help` for more detail.
86+
* See `gist --help` for more detail.
8987

9088
## Login
9189

@@ -119,7 +117,7 @@ This flow asks for your GitHub username and password (and 2FA code), and exchang
119117

120118
This token is stored in `~/.gist` and used for all future gisting. If you need to
121119
you can revoke it from https://github.com/settings/tokens, or just delete the
122-
file.
120+
file.
123121

124122
#### Password-less login
125123

@@ -165,7 +163,7 @@ Error: Bad credentials
165163

166164
# Library
167165

168-
You can also use Gist as a library from inside your ruby code:
166+
* You can also use Gist as a library from inside your ruby code:
169167

170168
Gist.gist("Look.at(:my => 'awesome').code")
171169

@@ -181,11 +179,11 @@ If you need more advanced features you can also pass:
181179

182180
NOTE: The access_token must have the `gist` scope and may also require the `user:email` scope.
183181

184-
If you want to upload multiple files in the same gist, you can:
182+
* If you want to upload multiple files in the same gist, you can:
185183

186184
Gist.multi_gist("a.rb" => "Foo.bar", "a.py" => "Foo.bar")
187185

188-
If you'd rather use gist's builtin access_token, then you can force the user
186+
* If you'd rather use gist's builtin access_token, then you can force the user
189187
to obtain one by calling:
190188

191189
Gist.login!
@@ -195,12 +193,12 @@ in `~/.gist`, where it can later be read by `Gist.gist`
195193

196194
## Configuration
197195

198-
If you'd like `-o` or `-c` to be the default when you use the gist executable, add an
196+
* If you'd like `-o` or `-c` to be the default when you use the gist executable, add an
199197
alias to your `~/.bashrc` (or equivalent). For example:
200198

201199
alias gist='gist -c'
202200

203-
If you'd prefer gist to open a different browser, then you can export the BROWSER
201+
* If you'd prefer gist to open a different browser, then you can export the BROWSER
204202
environment variable:
205203

206204
export BROWSER=google-chrome

Rakefile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@ end
1111

1212
task :man do
1313
mkdir_p "build"
14-
File.write "README.md.ron", File.read("README.md").gsub("\u200c", "* ")
15-
sh 'ronn --roff --manual="Gist manual" README.md.ron'
16-
rm 'README.md.ron'
14+
sh 'ronn --roff --manual="Gist manual" README.md'
1715
mv 'README.1', 'build/gist.1'
1816
end
1917

0 commit comments

Comments
 (0)