Skip to content

Commit 71a54f5

Browse files
committed
Fixes some spelling and grammar problems
1 parent af55566 commit 71a54f5

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Licensed under the GPLv2. See the file COPYING for details.
1717

1818

1919

20-
Requires
21-
--------
20+
Requirements
21+
------------
2222

23-
For using:
23+
For use:
2424
- C++ compiler with C++11 support.
2525

2626

@@ -29,24 +29,24 @@ For development:
2929
- [GNU Make](https://www.gnu.org/software/make/);
3030
- [CMake](http://www.cmake.org/) (2.8.12);
3131
- the test suite requires the [Google C++ Test Framework](http://code.google.com/p/googletest/);
32-
- microbenchmaring requires [Benchmark](https://github.com/google/benchmark), [Celero](https://github.com/DigitalInBlue/Celero), [Hayai](https://github.com/nickbruun/hayai) and [gprof](http://www.gnu.org/software/binutils/);
32+
- microbenchmarking requires [Benchmark](https://github.com/google/benchmark), [Celero](https://github.com/DigitalInBlue/Celero), [Hayai](https://github.com/nickbruun/hayai) and [gprof](http://www.gnu.org/software/binutils/);
3333
- code coverage requires [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) and lcov;
34-
- static code analyzis required [cppcheck](https://github.com/danmar/cppcheck).
34+
- static code analyzer requires [cppcheck](https://github.com/danmar/cppcheck).
3535

3636

3737

3838
Portability
3939
-----------
4040

41-
The project is developing under GNU/Linux OS with gcc compiler and usualy not tested under other OS and compilers.
42-
But in the project not used OS or compiler specific features (types, attributes, etc) so it's expected that the project will be normally work under other platforms.
41+
The project is developed under the GNU/Linux OS with the gcc compiler and usualy not tested under other OSs and compilers.
42+
But the project does not use OS or compiler specific features (types, attributes, etc) so it's expected that the project will be normally work under other platforms.
4343

4444

4545

4646
Usage
4747
-----
4848

49-
To use the project the following steps are required:
49+
These steps are the easiest way to get started:
5050
- download: ```$ git clone https://github.com/saebyn/munkres-cpp.git && cd munkres-cpp```
5151
- build: ```$ mkdir build && cd build $$ cmake .. && make```
5252
- install: ``` $ make install```
@@ -63,12 +63,13 @@ TBD
6363
Development
6464
-----------
6565

66-
For development purpose in the project implemented a variety of build targets.
66+
For development purpose, the project implements a variety of build targets.
6767
All of them help to continuously check correctness of algorithm implementation, performance, memory management, etc.
68-
To configure project in development mode ```-DMUNKRESCPP_DEVEL_MODE=ON``` option must be passed to CMake.
68+
Pass the```-DMUNKRESCPP_DEVEL_MODE=ON``` option to CMake to enable development mode.
6969

70-
Launch of unit tests.
71-
The project contains unit tests to build and launch it performs the following steps:
70+
# Running unit tests:
71+
72+
Build and execute the test suite with these commands:
7273
```
7374
$ git clone https://github.com/saebyn/munkres-cpp.git
7475
$ cd munkres-cpp
@@ -79,38 +80,42 @@ $ tests/munkrestest
7980
```
8081

8182

82-
Lunch code coverage analyze.
83-
To get correct report unit tests must be compiled in debug mode.
83+
# Running code coverage analyzer:
84+
85+
You must compile unit tests in debug mode to get a correct code coverage report.
8486
```
85-
$ <build and lunch unit tests>
87+
$ <build and Launch unit tests>
8688
$ make coverage
8789
$ firefox coverage/index.html &
8890
```
8991

9092

91-
Lunch memory profiler.
92-
As far unit tests call all functions which implement algorithm this is appropriate way to check memory management by using valgrind during performing unit tests.
93+
# Running the memory profiler:
94+
95+
Since the unit tests call all functions which implement the algorithm, using valgrind on the unit test runner is an appropriate way to check memory management.
9396
```
9497
$ <build unit tests>
9598
$ valgrind tests/munkrestest
9699
```
97100

98101

99-
Lunch microbenchmarks.
100-
Buildning microbenchmarks:
102+
# Running the microbenchmarks:
103+
104+
First, build them:
101105
```
102106
$ git clone https://github.com/saebyn/munkres-cpp.git
103107
$ cd munkres-cpp
104108
$ mkdir build && cd build
105109
$ cmake -DCMAKE_BUILD_TYPE=Release -DMUNKRESCPP_DEVEL_MODE=ON ..
106110
$ make benchmarks
107111
```
112+
108113
To get comparable results it's required to generate data set wich will be used for all benchmarks:
109114
```
110115
$ benchmarks/tools/generator/matrixgenerator.bin {dim_1 dim_2 ... dim_n}
111116
```
112-
Where every ```dim_x``` parameter generate square matrix dith ```dim_x``` dimension.
113-
To launch microbenchmark performs any following command:
117+
Where every ```dim_x``` parameter generates a square matrix with ```dim_x``` dimension.
118+
To launch microbenchmarks, perform the following commands:
114119
```
115120
$ benchmarks/tests/munkresbenchmark_celero.bin
116121
$ benchmarks/tests/munkresbenchmark_google.bin
@@ -119,21 +124,24 @@ $ benchmarks/tests/munkresbenchmark_rdtsc.bin
119124
```
120125

121126

122-
Lunch performance analyze.
127+
# Getting performance profiling:
128+
123129
```
124130
$ <build microbenchmarks and generate data set>
125131
$ benchmarks/tests/munkresbenchmark_gprof.bin
126132
$ gprof benchmarks/tests/munkresbenchmark_gprof.bin gmon.out -p -b
127133
```
128134

129135

130-
Lunch static code analyze.
136+
# Running the static code analyzer:
137+
131138
```
132139
$ make cppcheck
133140
```
134141

135142

136-
Lunch code formatter:
143+
# Running the code formatter:
144+
137145
TBD
138146

139147

0 commit comments

Comments
 (0)