Move from github, collapse gltk and strictmath, add candle

[clnl] / README.md

diff --git a/README.md b/README.md
index 18cc7a91533e144e6f76de175bcdaee5dc18f6c2..acb35a47b64b2c4a7ba4fac6c71584a5f28c681d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,20 +2,18 @@
 
 This is an experiment at creating an alternate implementation of NetLogo in Common Lisp.
 
-See the [wiki](https://github.com/frankduncan/clnl/wiki) for more information.
-
 # Using standalone executables
 
-Find the latest version, [0.1.0](https://github.com/frankduncan/clnl/releases/tag/v0.1.0) on the [releases page](https://github.com/frankduncan/clnl/releases):
-* [linux](https://github.com/frankduncan/clnl/releases/download/v0.1.0/clnl)
-* [windows](https://github.com/frankduncan/clnl/releases/download/v0.1.0/clnl.exe)
-* [mac](https://github.com/frankduncan/clnl/releases/download/v0.1.0/CLNL.dmg)
+Find the latest version, [0.1.0](https://code.consxy.com/gitweb/gitweb.cgi/clnl/commit/v0.1.0) on the [releases page](https://consxy.com/clnl/releases):
+* [linux](https://consxy.com/clnl/releases/v0.1.0/clnl)
+* [windows](https://consxy.com/clnl/releases/v0.1.0/clnl.exe)
+* [mac](https://consxy.com/clnl/releases/v0.1.0/CLNL.dmg)
 
 # Running from source
 
 If you'd like to run it from source, you're going to need a few things:
 
-* A copy of the clnl source (either from the [releases page](https://github.com/frankduncan/clnl/releases), version [0.1.0](https://github.com/frankduncan/clnl/releases/download/v0.1.0/clnl_0.1.0.tar.gz) or via cloning)
+* A copy of the clnl source from the [releases page](https://consxy.com/frankduncan/clnl/releases), version [0.1.0](https://consxy.com/clnl/releases/v0.1.0/clnl_0.1.0.tar.gz)
 * An implementation of sbcl with threads enabled
 * The following common lisp libraries (included in [deps/common-lisp](deps/common-lisp) folder)
   * alexandria
@@ -56,3 +54,35 @@ If you'd like to run using your own sbcl instance, you can attach the clnl.asd f
 (asdf:load-system :clnl)
 (clnl:run)
 ```
+
+# strictmath
+
+Pure common lisp implentation of Java's StrictMath class.  StrictMath is based on the pure software math library fdlibm, and as such, this solution should be equivalent and portable.
+
+## Limitations
+
+In the true "scratch an itch" category of software development, this library only does things as strictly needed by clnl in order to be consistent with regard to the JVM implementation of NetLogo.  Only the following things are implemented and tested:
+
+* Double precision only
+* Bounded to [0,360] or [0,2pi] only
+* The following StrictMath methods
+  * sin
+  * cos
+  * abs
+  * toRadians
+
+Anything else that works can be considered a pleasant surprise.
+
+## License
+
+This library lifts substantially from the evita-common-lisp implementation, as is noted in the LICENSE file.  Outside of that, functions are attempted ports of fdlibm functions, in as close as possible to a line for line translation.  As such, the files are similarly bound by the licenses included therein.
+
+## Dependencies
+
+The following are depended on by strictmath
+
+* ieee-floats
+
+# clnl-gltk
+
+This is a small experiment in creating some of the underlying tools that allows CLNL to implement NetLogo UI functionality.