Skip to content

Commit 12f7e1b

Browse files
committed
Remove shell prompts from copyable commands
1 parent bd5a653 commit 12f7e1b

3 files changed

Lines changed: 19 additions & 19 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@
133133
changes slightly the report that was produced. [#16][16]
134134

135135
```
136-
$ chaos report --export-format=pdf journal1.json journal2.json report.pdf
137-
$ chaos report --export-format=pdf journal*.json report.pdf
136+
chaos report --export-format=pdf journal1.json journal2.json report.pdf
137+
chaos report --export-format=pdf journal*.json report.pdf
138138
```
139139
140140
[16]: https://github.com/chaostoolkit/chaostoolkit-reporting/issues/16
@@ -270,4 +270,4 @@
270270
271271
### Added
272272
273-
- Initial release
273+
- Initial release

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ PDF or HTML document.
2222
Install this package as any other Python packages:
2323

2424
```console
25-
$ pip install -U chaostoolkit-reporting
25+
pip install -U chaostoolkit-reporting
2626
```
2727

2828
Notice that this draws a few [dependencies][deps]:
@@ -40,25 +40,25 @@ Once installed, a new `report` subcommand will be made available to the
4040
`chaos` command, use it as follows:
4141

4242
```console
43-
$ chaos report --export-format=html5 journal.json report.html
43+
chaos report --export-format=html5 journal.json report.html
4444
```
4545

4646
or, for a PDF document:
4747

4848
```console
49-
$ chaos report --export-format=pdf journal.json report.pdf
49+
chaos report --export-format=pdf journal.json report.pdf
5050
```
5151

5252
You can also generate a single report from many journals at once:
5353

5454
```console
55-
$ chaos report --export-format=pdf journal-1.json journal-2 journal-3 report.pdf
55+
chaos report --export-format=pdf journal-1.json journal-2 journal-3 report.pdf
5656
```
5757

5858
Or more succinctly:
5959

6060
```console
61-
$ chaos report --export-format=pdf journal-*.json report.pdf
61+
chaos report --export-format=pdf journal-*.json report.pdf
6262
```
6363

6464
## Download a Docker Image
@@ -70,7 +70,7 @@ pull. You can install `Docker` from the [Docker Hub][dockerhub].
7070
[dockerhub]: https://hub.docker.com/search?q=&type=edition&offering=community
7171

7272
```console
73-
$ docker pull chaostoolkit/reporting
73+
docker pull chaostoolkit/reporting
7474
```
7575

7676
### Use a Docker container
@@ -80,7 +80,7 @@ file, generated during an experiment run, can be found. To check for this you ca
8080

8181

8282
```console
83-
$ ls
83+
ls
8484
```
8585

8686
And you should see the `journal.json` file:
@@ -92,7 +92,7 @@ journal.json
9292
Now you can run the docker command:
9393

9494
```console
95-
$ docker run \
95+
docker run \
9696
--user `id -u` \
9797
-v `pwd`:/tmp/result \
9898
-it \
@@ -102,7 +102,7 @@ $ docker run \
102102
This will create `chaostoolkit.log` and `report.pdf` files in this directory.
103103

104104
```console
105-
$ ls
105+
ls
106106
```
107107

108108
```
@@ -120,14 +120,14 @@ The default command of the image is equivalent to running this without a
120120
container:
121121

122122
```console
123-
$ chaos report --export-format=pdf journal.json report.pdf
123+
chaos report --export-format=pdf journal.json report.pdf
124124
```
125125

126126
If you wish to override that command, pass the `chaos report` parameters as
127127
follows:
128128

129129
```console
130-
$ docker run \
130+
docker run \
131131
--user `id -u` \
132132
-v `pwd`:/tmp/result \
133133
-it \
@@ -138,7 +138,7 @@ $ docker run \
138138
And the same files will be created:
139139

140140
```console
141-
$ ls
141+
ls
142142
```
143143

144144
```

uni-install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ That's enough to produce HTML reports, but if you'd like to produce `.pdf` repor
1818
The best way to install `latex` is to use Homebrew to grab `basictex`:
1919

2020
```
21-
$ brew install basictex
21+
brew install basictex
2222
```
2323

2424
Then use `ls /usr/local/Caskroom/basictex/` to see the actual directory the package resides in. Finally use the `open` command to run that Mac OS X package installer, for example:
2525

2626
```
27-
$ open /usr/local/Caskroom/basictex/2017.0607/mactex-basictex-20170607.pkg
27+
open /usr/local/Caskroom/basictex/2017.0607/mactex-basictex-20170607.pkg
2828
```
2929

3030
### For Debian/Ubuntu
3131
We recommend using `sudo` to install the following packages:
3232

3333
```
34-
$ sudo apt-get install texlive-latex-base \
34+
sudo apt-get install texlive-latex-base \
3535
texlive-fonts-recommended \
3636
texlive-fonts-extra \
3737
texlive-latex-extra \
@@ -50,4 +50,4 @@ Once the installer has completed, you should then be able to produce `.pdf` repo
5050

5151
```RuntimeError: Python is not installed as a framework. The Mac OS X backend will not be able to function correctly if Python is not installed as a framework.```
5252

53-
In this case, run the following: `$ echo "backend: TkAgg" >> ~/.matplotlib/matplotlibrc`
53+
In this case, run the following: `echo "backend: TkAgg" >> ~/.matplotlib/matplotlibrc`

0 commit comments

Comments
 (0)