Skip to content

Commit

Permalink
Merge pull request #40 from bwvdnbro/bwvdnbro-patch-1
Browse files Browse the repository at this point in the history
Added some extra information to the README
  • Loading branch information
bwvdnbro authored Feb 26, 2018
2 parents a139c5c + bd36990 commit c2885a0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# CMacIonize
C++ version of Kenny Wood's ionization code.

- [Obtaining and compiling the code](#compilation)
- [Code dependencies](#dependencies)
- [Support](#support)

## Compilation

First, clone the repository using
Expand Down Expand Up @@ -79,3 +83,9 @@ by the unit tests, require Python, and the `numpy`, `matplotlib` and `h5py`
libraries. However, all files that are necessary for the unit tests are also
included in the repository (even if the scripts to generate them are), so
it is still possible to compile and run the code without Python.

## Support

If you have any issues obtaining, compiling or running the code, please consult the [wiki](https://github.com/bwvdnbro/CMacIonize/wiki) or let us know (bert.vandenbroucke@gmail.com). Try to use github issue were applicable to
- [submit bug reports](https://github.com/bwvdnbro/CMacIonize/issues/new?template=bug.md)
- [request new code features](https://github.com/bwvdnbro/CMacIonize/issues/new?template=enhancement.md)

0 comments on commit c2885a0

Please sign in to comment.