tupdated readme - sphere - GPU-based 3D discrete element method algorithm with … | |
git clone git://src.adamsgaard.dk/sphere | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit aedd397067714d2e427ceeaf7733d67a8970ab48 | |
parent f47bdf36b1edc4b3b73812a5f6802993dabbcc0c | |
Author: Anders Damsgaard Christensen <[email protected]> | |
Date: Wed, 5 Dec 2012 22:41:00 +0100 | |
updated readme | |
Diffstat: | |
M README.rst | 30 +++++++++++++++++------------- | |
1 file changed, 17 insertions(+), 13 deletions(-) | |
--- | |
diff --git a/README.rst b/README.rst | |
t@@ -11,29 +11,33 @@ See the ``doc/`` folder for general reference. | |
Requirements | |
============ | |
The build requirements are: | |
- - A Nvidia CUDA-supported version of Linux or Mac OS X | |
- - The GNU Compiler Collection (GCC) | |
- - The Nvidia CUDA toolkit and SDK | |
+ * A Nvidia CUDA-supported version of Linux or Mac OS X (see the `CUDA toolki… | |
+ * The `GNU Compiler Collection <http://gcc.gnu.org/>`_ (GCC) | |
+ * The `Nvidia CUDA toolkit and SDK <https://developer.nvidia.com/cuda-downlo… | |
The runtime requirements are: | |
- - A Nvidia CUDA-enabled GPU and device driver | |
+ * A `CUDA-enabled GPU <http://www.nvidia.com/object/cuda_gpus.html>`_ with c… | |
+ * A Nvidia CUDA-enabled GPU and device driver | |
Optional tools, required for simulation setup and data processing: | |
- - Python 2.7 | |
- - Numpy | |
- - Matplotlib | |
- - Imagemagick | |
- - ffmpeg | |
+ * `Python 2.7 <http://www.python.org/getit/releases/2.7/>`_ | |
+ * `Numpy <http://numpy.scipy.org>`_ | |
+ * `Matplotlib <http://matplotlib.org>`_ | |
+ * `Imagemagick <http://www.imagemagick.org/script/index.php>`_ | |
+ * `ffmpeg <http://ffmpeg.org/>`_ | |
Optional tools, required for building the documentation: | |
- - Sphinx | |
- - Doxygen | |
- - Breathe | |
+ * `Sphinx <http://sphinx-doc.org>`_ | |
+ * `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ | |
+ * `Breathe <http://michaeljones.github.com/breathe/>`_ | |
+ | |
+`Git <http://git-scm.com>`_ is used as the distributed version control system … | |
+ | |
Obtaining SPHERE | |
================ | |
The best way to keep up to date with subsequent updates, bugfixes | |
-and development, is to use the GIT version control system. | |
+and development, is to use the Git version control system. | |
To obtain a local copy, execute: | |
``git clone https://github.com/anders-dc/sphere.git`` |