|
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 |
2 | 14 |
|
3 | 15 | To build the executable on Linux or Mac, open a terminal in the neurofield directory and type:
|
4 | 16 |
|
5 | 17 | make
|
6 | 18 |
|
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`. |
8 | 20 |
|
9 | 21 | To build the reference manual, generated from the code, type:
|
10 | 22 |
|
11 | 23 | make reference-manual
|
12 | 24 |
|
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. |
14 | 26 |
|
15 | 27 | For a brief description of available Makefile targets, type:
|
16 | 28 |
|
17 | 29 | make help
|
18 | 30 |
|
19 |
| -### Setup guide |
20 | 31 |
|
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** |
22 | 32 |
|
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. |
24 | 36 |
|
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 |
26 | 38 |
|
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. |
28 | 40 |
|
29 |
| -### Troubleshooting |
| 41 | +## Troubleshooting |
30 | 42 |
|
31 | 43 | Problems compiling? Check [the following page](https://github.com/BrainDynamicsUSYD/neurofield/wiki/Troubleshooting) for the latest information.
|
32 | 44 |
|
33 |
| -### Guidelines for contributing code |
| 45 | +## How to contribute code |
34 | 46 |
|
35 | 47 | 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