Skip to content

Commit b082b9e

Browse files
authored
Cleanup main README.md (#170)
1 parent 8bbf97b commit b082b9e

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ sudo apt install scion-apps-*
4242
make setup_lint
4343
```
4444

45-
1. Run `make` build all projects (and run linters). Run `make -j` to use multiple jobs to build.
46-
47-
1. Run `make test` to
45+
1. Run `make` to build all projects (and run linters). Run `make -j` to use multiple jobs to build.
4846

49-
1. Run `make install` to build all projects and install into `$GOPATH/bin`
47+
1. Run `make test` to run the linters and unit tests.
48+
49+
1. Run `make install` to build all projects and install into `$GOPATH/bin`.
5050

5151

5252
### Running:
@@ -59,12 +59,12 @@ started.
5959
#### Environment
6060

6161
The dispatcher and sciond sockets are assumed to be at default locations, but
62-
this can be overriden using environment variables:
62+
this can be overridden using environment variables:
6363

6464
SCION_DISPATCHER_SOCKET: /run/shm/dispatcher/default.sock
6565
SCION_DAEMON_ADDRESS: 127.0.0.1:30255
6666

67-
This is convenient for the normal use case of running a the endhost stack for a
67+
This is convenient for the normal use case of running the endhost stack for a
6868
single SCION AS.
6969
When running multiple local ASes, e.g. during development, the address of the
7070
sciond corresponding to the desired AS needs to be specified in the
@@ -92,13 +92,14 @@ resolver, in the form `<ISD>-<AS>,[<IP>]`.
9292

9393
## bat
9494

95-
bat is a CLI cURL-like tool for testing, debugging, and generally interacting with HTTP servers over SCION/QUIC. Documentation of the code is available in the [README.md](bat/README.md)
95+
bat is a cURL-like tool for testing, debugging, and generally interacting with HTTP servers over SCION/QUIC. Documentation of the code is available in the [README.md](bat/README.md).
9696

9797
Installation and usage information is available on the [SCION Tutorials web page for bat](https://docs.scionlab.org/content/apps/bat.html).
9898

99+
99100
## camerapp
100101

101-
Camerapp contains image fetcher and server applications, using the SCION network. Documentation of the code is available in the [README.md](https://github.com/netsec-ethz/scion-apps/blob/master/camerapp/README.md)
102+
Camerapp contains image fetcher and server applications, using the SCION network. Documentation of the code is available in the [README.md](https://github.com/netsec-ethz/scion-apps/blob/master/camerapp/README.md).
102103

103104
Installation and usage information is available on the [SCION Tutorials web page for camerapp](https://docs.scionlab.org/content/apps/access_camera.html).
104105

0 commit comments

Comments
 (0)