Skip to content

Commit 47054b2

Browse files
committed
fixed typo in readme as spotted by andrewtrotman
1 parent 2aa82d0 commit 47054b2

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,37 +30,37 @@ To build the code, [`CMake`](https://cmake.org/) is required.
3030

3131
Clone the repository with
3232

33-
$ git clone --recursive https://github.com/jermp/interpolative_coding.git
33+
git clone --recursive https://github.com/jermp/interpolative_coding.git
3434

3535
If you have cloned the repository without `--recursive`, you will need to perform the following commands before
3636
compiling:
3737

38-
$ git submodule init
39-
$ git submodule update
38+
git submodule init
39+
git submodule update
4040

4141
To compile the code for a release environment *and* best performance (see file `CMakeLists.txt` for the used compilation flags), do:
4242

43-
$ mkdir build
44-
$ cd build
45-
$ cmake .. -DRUNAWARE=On
46-
$ make
43+
mkdir build
44+
cd build
45+
cmake .. -DRUNAWARE=On
46+
make
4747

4848
Hint: Use `make -j4` to compile the library in parallel using, e.g., 4 jobs.
4949

5050
For a testing environment, use the following instead:
5151

52-
$ mkdir debug_build
53-
$ cd debug_build
54-
$ cmake .. -DCMAKE_BUILD_TYPE=Debug -DUSE_SANITIZERS=On
55-
$ make
52+
mkdir debug_build
53+
cd debug_build
54+
cmake .. -DCMAKE_BUILD_TYPE=Debug -DUSE_SANITIZERS=On
55+
make
5656

5757
Quick Start
5858
-------
5959

6060
For a quick start, see the source file `test/example.cpp`.
6161
After compilation, run this example with
6262

63-
$ ./example
63+
./example
6464

6565
A simpler variation is shown below.
6666

@@ -146,15 +146,15 @@ such organization.
146146
147147
To encode all the sequences from this file, do:
148148
149-
$ ./encode leftmost_minimal ../data/test_collection.docs -o test.bin
149+
./encode leftmost_minimal ../data/test_collection.docs -o test.bin
150150
151151
To decode all the sequences from the encoded file `test.bin`, do:
152152
153-
$ ./decode leftmost_minimal test.bin
153+
./decode leftmost_minimal test.bin
154154
155155
To check correctness of the implementation, use:
156156
157-
$ ./check leftmost_minimal ../data/test_collection.docs test.bin
157+
./check leftmost_minimal test.bin ../data/test_collection.docs
158158
159159
which will compare every decoded integer against the input collection.
160160

0 commit comments

Comments
 (0)