update readme

README.md

@@ -24,61 +24,36 @@ potentials and functions defined on chunkers
 compressed inverse preconditioning (RCIP) scheme for effectively
 treating problems with corners and multiple junctions.
 
+Detailed documentation is being built [here](https://chunkie.readthedocs.io/en/latest/)
+
 ## Installing chunkIE
 
-Clone the repository with the submodules 
+For other install options, see [the documentation.](https://chunkie.readthedocs.io/en/latest/getchunkie.html)
+
+To compile from git, clone the repository with the submodules 
 
     git clone --recurse-submodules https://github.com/fastalgorithms/chunkie.git
 
 and run startup.m in the install directory. 
 This will download the FLAM and fmm2d submodules, include FLAM in 
 the matlab path, and generate the fmm2d mex file if a fortran compiler
-exists. 
+exists.
+
+For troubleshooting suggestions, see [the documentation](https://chunkie.readthedocs.io/en/latest/getchunkie.html)
 
 ## Using chunkIE
 
-Check out the chunkie/demo folder.
+Check out the chunkie/demo folder or the [guide (under construction)](https://chunkie.readthedocs.io/en/latest/guide.html)
 
 ## License
 
-chunkIE is copyright 2019 the chunkIE team
+chunkIE is copyright 2024 the chunkIE team
 
 chunkIE proper (the contents of the chunkie
 folder) is available under the terms of the
 BSD 3-clause license, which should have been included
 in the distribution (see chunkie/LICENSE.md)
 
-## Installation notes
-
-- The fmm2d mex installation is currently not supported on Windows, to
-  complete the mex installation, follow instructions on the [fmm2d documentation](https://fmm2d.readthedocs.io/en/latest/install.html) 
-- fmm2d mex installation depends on gfortran. In case a compiler is not
-  found, the installation will be skipped. To install dependencies follow the procedure below based on your OS
-
-  * MacOS
-
-    Get xcode, command line tools by running
-
-        xcode-select --install
-
-    Then install Homebrew from https://brew.sh, and finally install gfortran using
-
-        brew install gcc
-
-  * Ubuntu linux
-
-        sudo apt-get install make build-essential gfortran
-
-  * Fedora/centOS linux
-
-        sudo yum install make gcc gcc-c++ gcc-gfortran libgomp
-
-- If installing without submodules, chunkIE depends on [FLAM](https://github.com/klho/FLAM), 
-and optionally on the
-[fmm2d](https://github.com/flatironinstitute/fmm2d) repository. Parts of
-the library will not function without FLAM and its subdirectories included in the matlab path.
-
-
 ## chunkIE team
 
 chunkIE has benefitted from the contributions of several developers: Travis Askham, 
@@ -89,19 +64,19 @@ James Bremer and Zydrunas Gimbutas provided generalized Gaussian quadrature rule
 
 Many routines were modelled after parts of the legeexps.f library (Copyright Vladimir Rokhlin, Free BSD 3-clause),
 FMMLIB2D (Copyright Leslie Greengard and Zydrunas Gimbutas, Free BSD 3-clause), and Johan Helsing's
-RCIP tutorial (https://arxiv.org/abs/1207.6737)
+[RCIP tutorial](https://arxiv.org/abs/1207.6737)
 
 ## Citing this software
 
 If you found this software useful, we ask that you please cite the following
 works
 
-- [This software] see CITATIONS.cff for details
-- [The fast multipole method library] https://github.com/flatironinstitute/fmm2d
-- [The fast direct solver library] Ho, Kenneth L. "FLAM: Fast linear algebra in MATLAB-Algorithms for hierarchical matrices." Journal of Open Source Software 5.51 (2020): 1906.
-- [Quadrature generation routines] Bremer, James, Zydrunas Gimbutas, and Vladimir Rokhlin. "A nonlinear optimization procedure for generalized Gaussian quadratures." SIAM Journal on Scientific Computing 32.4 (2010): 1761-1788.
-- [Corner and multiple junction handling] Helsing, Johan. "Solving integral equations on piecewise smooth boundaries using the RCIP method: a tutorial." Abstract and applied analysis. Vol. 2013. Hindawi, 2013.
-- [Fast multipole method paper] Greengard, Leslie, and Vladimir Rokhlin. "A fast algorithm for particle simulations." Journal of computational physics 73.2 (1987): 325-348.
+- {This software} see CITATIONS.cff for details
+- {The fast multipole method library} https://github.com/flatironinstitute/fmm2d
+- {The fast direct solver library} Ho, Kenneth L. "FLAM: Fast linear algebra in MATLAB-Algorithms for hierarchical matrices." Journal of Open Source Software 5.51 (2020): 1906.
+- {Quadrature generation routines} Bremer, James, Zydrunas Gimbutas, and Vladimir Rokhlin. "A nonlinear optimization procedure for generalized Gaussian quadratures." SIAM Journal on Scientific Computing 32.4 (2010): 1761-1788.
+- {Corner and multiple junction handling} Helsing, Johan. "Solving integral equations on piecewise smooth boundaries using the RCIP method: a tutorial." Abstract and applied analysis. Vol. 2013. Hindawi, 2013.
+- {Fast multipole method paper} Greengard, Leslie, and Vladimir Rokhlin. "A fast algorithm for particle simulations." Journal of computational physics 73.2 (1987): 325-348.
 
 ## Contributing