rearrange docs/readme

docs/index.md

@@ -1,5 +1,73 @@
 
 # MAGCODE: framework of models for calculating magnetic fields and interactions
 
-Hello!
+This repository contains code originally written for my PhD for calculating the forces
+(and stiffnesses) between permanent magnets and arrays of magnets.
 
+The GitHub repository for this code is located at: <https://github.com/wspr/magcode>
+
+It has been originally written in Matlab and a little Mathematica,
+and I plan on adding translations into other programming languages as time permits.
+Contributions happily accepted.
+
+
+Philosophy
+----------
+
+As time goes by, it becomes increasingly difficult to build on the work of our
+predecessors unless we build tools to abstract the ideas we invent in our research.
+This code marks my first attempt to freely share, in a useful way, the work of my PhD.
+
+
+Installation and information
+----------------------------
+
+The `matlab/` subdirectory of this repository contains the source files.
+After cloning the Git repository, you can simply add the `matlab/` folder to your Matlab
+path in order to start using the code.
+
+The documentation `matlab/magcode-matlab.pdf` contains both a user's guide and the
+documented source code in a literate programming style.
+
+
+Examples and test suite
+-----------------------
+
+The `examples/` subdirectory contains a number of files to illustrate the use of the `magnetforces` code (and other related things). These files are:
+
+- `allag_torques.m` is an implementation of the theory of [Allag and Yonnet (2009)][1] for calculating the torques between cuboid magnets.
+- `magnetforces_example.m` contains a reproduction of the results of [Akoun and Yonnet (1984)][2] and of [Janssen et al. (2009)][3].
+- `multipole_compare.m` is an unfinished comparison between different configurations of multipole arrays.
+- `multipole_example.m` is a reproduction of the multipole results shown by [Allag, Yonnet, and Latreche (2009)][4].
+
+[1]: http://dx.doi.org/10.1109/TMAG.2009.2025047
+[2]: http://dx.doi.org/10.1109/TMAG.1984.1063554
+[3]: http://dx.doi.org/10.1166/sl.2009.1049
+[4]: http://dx.doi.org/10.1109/ELECTROMOTION.2009.5259084
+
+The source code contains a number of automated tests to ensure that future changes don't break existing functionality or start producing incorrect results. These are not included in the repository for clarity; extract them with `mtangle`.
+
+
+Contributors
+------------
+
+The following students have contributed to this work over the years:
+
+* Joost Ziggers
+* Daan Wilmink
+* Allan Liu
+* Matthew Forbes
+* James O'Connell
+
+
+Licence for modification and distribution
+-----------------------------------------
+
+This work is freely modifiable and distributable under the terms and conditions of the
+[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0).
+In effect, you are free to do with this code as you wish for the development of free or proprietary software.
+Distributions of modified works must retain the original copyright notices and contain a list of modifications made, but this is only an expository notice; please see the licence text for complete details.
+
+----------------------------------
+Copyright 2009–2018 Will Robertson
+will.robertson@adelaide.edu.au

readme.markdown

@@ -1,40 +1,9 @@
-Calculating the force between magnets and multipole arrays of magnets
-=====================================================================
+MAGCODE: framework of models for calculating magnetic fields and interactions
+=============================================================================
 
-This repository contains code originally written for my PhD for calculating the forces (and stiffnesses) between permanent magnets and arrays of magnets.
+Public-facing documentation for this repository is located at: <http://wspr.io/magcode/>
 
-It has been originally written in Matlab, and I plan on adding translations into other programming languages as time permits. Contributions happily accepted.
 
-Philosophy
-----------
-
-As time goes by, it becomes increasingly difficult to build on the work of our predecessors unless we build tools to abstract the ideas we invent in our research. This code marks my first attempt to freely share, in a useful way, the work of my PhD.
-
-Installation and information
-----------------------------
-
-The `matlab/` subdirectory of this repository contains both the source file
-`magnetforces.web` and the ready-to-use Matlab functions `magnetforces.m` and
-`multipoleforces.m`. After cloning this Git repository, you can simply add the `matlab/` folder to your Matlab path in order to start using the code.
-
-The documentation `matlab/magcode-matlab.pdf` contains both a user's guide and the documented source code in a literate programming style.
-
-Examples and test suite
------------------------
-
-The `examples/` subdirectory contains a number of files to illustrate the use of the `magnetforces` code (and other related things). These files are:
-
-- `allag_torques.m` is an implementation of the theory of [Allag and Yonnet (2009)][1] for calculating the torques between cuboid magnets. I believe their theory is incorrect and this example is supposed to illustrate why.
-- `magnetforces_example.m` contains a reproduction of the results of [Akoun and Yonnet (1984)][2] and of [Janssen et al. (2009)][3].
-- `multipole_compare.m` is an unfinished comparison between different configurations of multipole arrays.
-- `multipole_example.m` is a reproduction of the multipole results shown by [Allag, Yonnet, and Latreche (2009)][4].
-
-[1]: http://dx.doi.org/10.1109/TMAG.2009.2025047
-[2]: http://dx.doi.org/10.1109/TMAG.1984.1063554
-[3]: http://dx.doi.org/10.1166/sl.2009.1049
-[4]: http://dx.doi.org/10.1109/ELECTROMOTION.2009.5259084
-
-The source code contains a number of automated tests to ensure that future changes don't break existing functionality or start producing incorrect results. These are not included in the repository for clarity; extract them with `mtangle`. 
 
 Licence for modification and distribution
 -----------------------------------------
@@ -44,6 +13,3 @@ This work is freely modifiable and distributable under the terms and conditions
 In effect, you are free to do with this code as you wish for the development of free or proprietary software.
 Distributions of modified works must retain the original copyright notices and contain a list of modifications made, but this is only an expository notice; please see the licence text for complete details.
 
-----------------------------------
-Copyright 2009–2010 Will Robertson  
-wspr81 at gmail dot com