Skip to content

Commit 77b0324

Browse files
author
Paula Sanz-Leon
committed
Update readme
1 parent 01bda8c commit 77b0324

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
### Quick start
1+
# Neurofield
2+
3+
This library implements methods to simulate neural field models,
4+
based on Robinson's Neural Field Theory.
5+
6+
7+
## Installation
8+
9+
1. Fork and clone; or,
10+
11+
2. download the latest [release](https://github.com/BrainDynamicsUSYD/neurofield/releases) as a `.zip` or `tar.gz` file.
12+
13+
### Build/compilation
214

315
To build the executable on Linux or Mac, open a terminal in the neurofield directory and type:
416

517
make
618

7-
this produces the executable (bin/neurofield). The user-manual is available as doc/NeurofieldManual.pdf.
19+
this produces the executable (`bin/neurofield`). The user-manual is available as `doc/NeurofieldManual.pdf`.
820

921
To build the reference manual, generated from the code, type:
1022

1123
make reference-manual
1224

13-
The html files for the reference-manual will be place under `doc/html`, point your browser at the index.html file in that directory.
25+
The html files for the reference-manual will be placed under `doc/html`, point your browser at the index.html file in that directory.
1426

1527
For a brief description of available Makefile targets, type:
1628

1729
make help
1830

19-
### Setup guide
2031

21-
**Please check the [NeuroField wiki](https://github.com/BrainDynamicsUSYD/neurofield/wiki) for the setup walkthrough. The instructions below are a standalone summary if you do not have internet access. More detailed instructions are also included in the PDF documentation**
2232

23-
1. Ensure you have a compiler that supports the `C++11` standard. We recommend GCC 4.8 or higher.
33+
**NOTE**: Ensure you have a compiler that supports the `C++11` standard.
34+
On Linux: g++ 4.8 or higher; clang 3.7 or higher.
35+
On MacOS: TBD.
2436

25-
2. Type `make` to build the binary `bin/neurofield`. More information about [cross platform for non-Linux](https://github.com/BrainDynamicsUSYD/neurofield/wiki/Cross-platform-support) systems is also available.
37+
## Demos
2638

27-
3. Example configurations including examples for published results are available in the `configs` folder.
39+
Example configurations including examples for published results are available in the `configs` folder.
2840

29-
### Troubleshooting
41+
## Troubleshooting
3042

3143
Problems compiling? Check [the following page](https://github.com/BrainDynamicsUSYD/neurofield/wiki/Troubleshooting) for the latest information.
3244

33-
### Guidelines for contributing code
45+
## How to contribute code
3446

3547
If you intend to contribute to NeuroField development, please make a private fork of this repository and follow the [instructions for contributors.](https://github.com/BrainDynamicsUSYD/neurofield/wiki/How-to-contribute-code-to-NeuroField)

0 commit comments

Comments
 (0)