diff options
| author | Franklin Wei <me@fwei.tk> | 2019-03-07 19:23:12 -0500 |
|---|---|---|
| committer | Franklin Wei <me@fwei.tk> | 2019-03-07 19:25:42 -0500 |
| commit | e295cf5e9f029b3e4fb3422acbb48f82231c2327 (patch) | |
| tree | bbef40ac0ea80a9541d79cfdd9012aae0efb598e | |
| parent | 6c56267423a403c5da23380e9d6f23e8926ffb46 (diff) | |
| download | fieldviz-e295cf5e9f029b3e4fb3422acbb48f82231c2327.zip fieldviz-e295cf5e9f029b3e4fb3422acbb48f82231c2327.tar.gz fieldviz-e295cf5e9f029b3e4fb3422acbb48f82231c2327.tar.bz2 fieldviz-e295cf5e9f029b3e4fb3422acbb48f82231c2327.tar.xz | |
Clean up, add README
| -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. |