diff options
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..99389c9 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# fieldviz: A electric/magnetic field integrator + +This program allows the calculation of the electric or magnetic field +in a region with arbitrary charge/current distributions. + +# Installation + +You will need my math library from +https://github.com/built1n/libfml/. Build and install that before +proceeding. + +Then build using cmake: + + mkdir build + cd build + cmake .. + make + +This should give you a `fieldviz` executable. Run in-place or do + + sudo make install + +To install system-wide. |