Skip to content

Commit dcfa868

Browse files
committed
Remove shell indicators from readme
Change-Id: I57fbee312cc8ca7dc8d241fe2efa690d6c57a4da
1 parent 1f81823 commit dcfa868

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Go 1.19 or later
2222
To build the latest version of `Kalamar-Plugin-ExternalResources`, do ...
2323

2424
```shell
25-
$ git clone https://github.com/KorAP/Kalamar-Plugin-ExternalResources
26-
$ cd Kalamar-Plugin-ExternalResources
27-
$ go test .
28-
$ go build .
25+
git clone https://github.com/KorAP/Kalamar-Plugin-ExternalResources
26+
cd Kalamar-Plugin-ExternalResources
27+
go test .
28+
go build .
2929
```
3030

3131
## Running
@@ -54,7 +54,7 @@ These files can be gzipped as well.
5454
Then run the indexation with:
5555

5656
```shell
57-
$ ./Kalamar-Plugin-ExternalResources data.csv
57+
./Kalamar-Plugin-ExternalResources data.csv
5858
```
5959

6060
## Customization
@@ -72,40 +72,40 @@ Currently no official Docker image is provided.
7272
To build an image based on the provided Dockerfile, run
7373

7474
```shell
75-
$ docker build \
76-
-f Dockerfile \
77-
-t korap/kalamar-plugin-externalresources .
75+
docker build \
76+
-f Dockerfile \
77+
-t korap/kalamar-plugin-externalresources .
7878
```
7979

8080
To create a container on Linux based on the image
8181
with a mounted database in `db`
8282
and a configuration file, run
8383

8484
```shell
85-
$ docker run \
86-
--rm \
87-
--network host \
88-
-v ${PWD}/db/:/db/:z \
89-
-v ${PWD}/.env:/.env korap/ \
90-
kalamar-plugin-externalresources
85+
docker run \
86+
--rm \
87+
--network host \
88+
-v ${PWD}/db/:/db/:z \
89+
-v ${PWD}/.env:/.env korap/ \
90+
kalamar-plugin-externalresources
9191
```
9292

9393
To index using docker, run
9494

9595
```shell
96-
$ docker run \
97-
--rm \
98-
--network host \
99-
-v ${PWD}/db/:/db/:z \
100-
-v ${PWD}/data/:/data \
101-
-v ${PWD}/.env:/.env \
102-
korap/kalamar-plugin-externalresources \
103-
data/data.csv.gz
96+
docker run \
97+
--rm \
98+
--network host \
99+
-v ${PWD}/db/:/db/:z \
100+
-v ${PWD}/data/:/data \
101+
-v ${PWD}/.env:/.env \
102+
korap/kalamar-plugin-externalresources \
103+
data/data.csv.gz
104104
```
105105

106106
## License
107107

108-
Copyright (c) 2023, [IDS Mannheim](https://www.ids-mannheim.de/), Germany<br>
108+
Copyright (c) 2023-2024, [IDS Mannheim](https://www.ids-mannheim.de/), Germany<br>
109109
Author: [Nils Diewald](https://www.nils-diewald.de/)
110110

111111
Kalamar-Plugin-ExternalResources is developed as part of the

0 commit comments

Comments
 (0)