Skip to content

Commit fcad184

Browse files
committed
Fixed typos in README.md
1 parent 4332414 commit fcad184

File tree

2 files changed

+15
-25
lines changed

2 files changed

+15
-25
lines changed

GPATH

0 Bytes
Binary file not shown.

README.md

+15-25
Original file line numberDiff line numberDiff line change
@@ -37,32 +37,24 @@ a) Clone the code from the GitHub repository using
3737

3838
git clone https://github.com/sknepneklab/SAMoS.git
3939

40-
b) cd SAMoS (or the name of the directory you chose to download the code into)
41-
42-
c) mkdir build
43-
44-
d) cd build
45-
46-
e) ccmake ../
47-
48-
f) Use the CMake's GUI to chose appropriate settings
49-
50-
g) Press 'c' key several times to configure
51-
52-
h) If all libraries have been found, CMake will allow you to create a Makefile. If not, please exit CMake GUI and install missing libraries.
53-
54-
i) Press 'g' to create Make files. This will terminate CMake's GUI is return you to the shell
55-
56-
j) Type 'make -j 8' (-j option tells make how many parallel threads to use to compile; on a 4-core machine one can typically use 8 threads).
40+
b) cd SAMoS (or the name of the directory you chose to download the code into) <br />
41+
c) mkdir build <br />
42+
d) cd build <br />
43+
e) ccmake ../ <br />
44+
f) Use the CMake's GUI to chose appropriate settings <br />
45+
g) Press 'c' key several times to configure <br />
46+
h) If all libraries have been found, CMake will allow you to create a Makefile. If not, please exit CMake GUI and install missing libraries. <br />
47+
i) Press 'g' to create Make files. This will terminate CMake's GUI is return you to the shell. <br />
48+
j) Type 'make -j 8' (-j option tells make how many parallel threads to use to compile; on a 4-core machine one can typically use 8 threads). <br />
49+
k) If the compilation is successful, an executable 'samos' should appear in the build directory.
5750

5851
**NOTE:** Some Linux distributions with newer C++ compilers may have problems with running 8 parallel threads and can cause the machine to crash.
5952
If this happens, use '-j 2', which is likely not to cause any problems on most modern computers.
6053

61-
k) If the compilation is successful, an executable 'samos' should appear in the build directory.
62-
6354
**NOTE:** SAMoS uses many templated libraries in Boost. Compiling it may take several minutes even on a very fast machine.
6455

6556
**NOTE:** Depending on the compiler, you may get a number of warning messages. Those are harmless and you may safely ignore them.
57+
6658
**NOTE:** SAMoS will fail to compile using the C++11 standard!
6759

6860
**WARNING:** Some Mac users have reported problems with compiling SAMoS on Sierra and High Sierra using packages installed with 'brew'. Switching to
@@ -133,16 +125,14 @@ samos
133125

134126
## 8. CREDITS
135127

136-
Lead developer:
128+
### Lead developer:
137129

138130
Rastko Sknepnek (University of Dundee, UK)
139131

140-
Major contributors to the code:
141-
142-
Silke Henkes (University of Aberdeen, UK) - many tools for building inital configurations and analysis tools
143-
144-
Daniel Barton (University of Dundee, UK) - tools for building and analysing tissue mechanics simulations
132+
### Major contributors to the code:
145133

134+
Silke Henkes (University of Aberdeen, UK) - many tools for building inital configurations and analysis tools <br />
135+
Daniel Barton (University of Dundee, UK) - tools for building and analysing tissue mechanics simulations <br />
146136
Amit Das (National Institute for Biological Sciences, India) - tools for building and analysing actomyosin simulations
147137

148138

0 commit comments

Comments
 (0)