Merge pull request #18 from tshort/mkdocs-candidate

Mkdocs candidate

Author: iraikov

LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2012, Electric Power Research Institute
-All rights reserved.
+Copyright (c) 2012 - 2015, Electric Power Research Institute and Ivan
+Raikov.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
@@ -23,4 +23,11 @@ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+This code also contains documentation adapted from the Modelica
+Standard Library available under the Modelica License Version 2 (an
+allowed usage). See here:
+
+https://www.modelica.org/licenses/ModelicaLicense2
+https://www.modelica.org/news_items/modelica-standard-library-3.2.1-released

README.md

@@ -1,15 +1,10 @@
 
-Julia Sims
-==========
+Sims.jl
+=======
 
-Introduction
-------------
-
-Sims is a Julia package to support equation-based modeling for
-simulations. Sims is like a lite version of Modelica.
-
-[Julia](http://julialang.org) is a fast, Matlab-like language that is
-well suited to modeling and simulations.
+A [Julia](http://julialang.org) package for equation-based modeling
+and simulations. For more information, see the
+**[Documentation](https://tshort.github.io/Sims.jl/)**.
 
 
 Background
@@ -59,16 +54,14 @@ Sims is an installable package. To install Sims, use the following:
 Pkg.add("Sims")
 ```
 
-Sims attempts to compile the DASKR solver (in Sims/lib) if the dynamic
-linked library is not found. If DASKR is updated, it may need to be
-recompiled (the function `Sims.compile_daskr` does this). Note: to
-compile DASKR, gfortran must be installed. To use the Sundials solver,
-you must have the Sundials C
-[library](https://computation.llnl.gov/casc/sundials/main.html)
-installed as well as the Julia Sundials package.
+Sims.jl has one main module named `Sims` and the following submodules:
 
-Sims.jl has one main module named `Sims`. This module includes
-simulation code and a standard library of components. 
+* `Sims.Lib` -- the standard library
+
+* `Sims.Examples` -- example models, including:
+  * `Sims.Examples.Basics`
+  * `Sims.Examples.Lib`
+  * `Sims.Examples.Neural`
 
 Basic example
 -------------
@@ -269,29 +262,7 @@ was done in R, not Julia.
 
 ![plot results](https://github.com/tshort/Sims.jl/blob/master/examples/basics/pendulum.gif?raw=true "Pendulum")
 
-To Look Deeper
---------------
-
-For further examples, see here:
-    
-https://github.com/tshort/Sims.jl/tree/master/examples
-
-Minimal documentation is here:
-
-https://github.com/tshort/Sims.jl/blob/master/doc/README.md
-
-The main code that defines functions and types for simulations is
-here:
-
-https://github.com/tshort/Sims.jl/blob/master/src/sim.jl
-
-For future development options, see here:
 
-https://github.com/tshort/Sims.jl/blob/master/doc/Possible-future-developments.md
 
-Status
-------
 
-Please note that this is a developer preview. There could be bugs, and
-everything is subject to change.