diff --git a/README.md b/README.md index 37f1f17336218e87abcaeba05b7e5173c8498071..d5f3a5e539ab205bf7ba8a8aa0deaead6b3037aa 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ [](https://travis-ci.org/BhallaLab/moose) -This is meta repository of MOOSE simulator. It contains C++ core of MOOSE, -python scripting interface, its GUI repositories as submodule. +This is the parent repository of [MOOSE simulator](https://moose.ncbs.res.in). It contains core (written in C++) of MOOSE, it's python scripting interface, and its graphical user interface (GUI) as [git-submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules). -For more details about these sub-projects, read respective README: +You can find detailed description of each MOOSE component in respective `README.md` in their repositories below: -- [MOOSE and PyMOOSE](https://github.com/BhallaLab/moose-core) -- [Gui](https://github.com/BhallaLab/moose-gui) +- [MOOSE with python support](https://github.com/BhallaLab/moose-core) +- [GUI](https://github.com/BhallaLab/moose-gui) - [Examples and Demos](https://github.com/BhallaLab/moose-examples) +# MOOSE Packages + +The easiest way of installing MOOSE on your system is to use pre-compiled packages. + +## Ubuntu + +MOOSE has [a PPA ](https://launchpad.net/~bhallalab/+archive/ubuntu/moose). + +You can use it on Ubuntu 12.04, 14.04, 14.10, and 15.04. + + +### Terminal + + sudo -E add-apt-repository ppa:bhallalab/moose + sudo apt-get update + sudo apt-get install moose-python moose-gui + +*[What are PPAs and how to use them]http://askubuntu.com/questions/4983/what-are-ppas-and-how-do-i-use-them)* + + +## Others + +We are building packages for other distribution as well. We use [Open Build Service](https://build.opensuse.org/package/show/home:moose/moose). Packages and installation instructions can be [found here](http://software.opensuse.org/download.html?project=home%3Amoose&package=moose). + + # Installation using cmake First, run the `bootstrap` script. It will fetch the submodules and/or update @@ -37,25 +61,6 @@ previous `make install` command. sudo make uninstall -# Packages - -The easiest way of installing MOOSE on your system is to use packages. - -## Ubuntu - -There is a [PPA](https://launchpad.net/~bhallalab/+archive/ubuntu/moose). - -You can use it on Ubuntu 12.04, 14.04, 14.10, and 15.04. - - sudo -E add-apt-repository ppa:bhallalab/moose - sudo apt-get update - sudo apt-get install moose-python moose-gui - - -## Others - -We are building packages for other distribution as well. We use [Open Build Service](https://build.opensuse.org/package/show/home:moose/moose). Packages and installation instructions can be [found here](http://software.opensuse.org/download.html?project=home%3Amoose&package=moose). - # Reporting issues Please report all build and packaging related issues here. For development