Skip to content

Commit 2dd9a4a

Browse files
committed
enh: update Readme
1 parent 49f6994 commit 2dd9a4a

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# NeuroML API for C++
22

3-
C++ API for NeuroML 2
3+
C++ API for NeuroML 2.
4+
5+
[![Build Status](https://travis-ci.org/NeuroML/NeuroML_API.svg?branch=master)](https://travis-ci.org/NeuroML/NeuroML_API)
6+
[![GitHub](https://img.shields.io/github/license/NeuroML/NeuroML_API)](https://github.com/NeuroML/NeuroML_API/blob/master/License.txt)
7+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/NeuroML/NeuroML_API)](https://github.com/NeuroML/NeuroML_API/pulls)
8+
[![GitHub issues](https://img.shields.io/github/issues/NeuroML/NeuroML_API)](https://github.com/NeuroML/NeuroML_API/issues)
9+
[![GitHub Org's stars](https://img.shields.io/github/stars/NeuroML?style=social)](https://github.com/NeuroML)
10+
[![Twitter Follow](https://img.shields.io/twitter/follow/NeuroML?style=social)](https://twitter.com/NeuroML)
411

5-
**Work in progress, but usable.** See https://github.com/NeuroML/NeuroML2/issues/102.
612

713
## Using the API
814

@@ -65,7 +71,7 @@ your system and findable by CMake. The build will search standard install
6571
locations, but you can also set the `XSD_ROOT` _environment_ variable to the
6672
root folder for the software (i.e. the folder containing `bin` and `libxsd`
6773
folders). You can also change the schema file to use by setting the variable
68-
`NeuroML_SCHEMA_PATH` in ccmake.
74+
`NeuroML_SCHEMA_PATH` in CMake.
6975

7076
Once the bindings have been regenerated, you can run `make copy_wrappers`
7177
to copy the new versions back into the source tree, for committing to the
@@ -74,5 +80,3 @@ repository.
7480
[XSD user manual]: http://www.codesynthesis.com/projects/xsd/documentation/cxx/tree/manual/
7581
[cpack documentation]: https://cmake.org/cmake/help/v3.5/manual/cpack.1.html
7682
[Xerces C++]: http://xerces.apache.org/xerces-c/
77-
78-
[![Build Status](https://travis-ci.org/NeuroML/NeuroML_API.svg?branch=master)](https://travis-ci.org/NeuroML/NeuroML_API)

0 commit comments

Comments
 (0)