From af14b29ecab7757e9492c4b0845a121c3ec03728 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franck=20P=C3=A9rignon?= <franck.perignon@imag.fr>
Date: Wed, 4 May 2016 17:44:23 +0200
Subject: [PATCH] cleaning
---
README | 28 ---------------------
README.md | 27 ++++++++++++++++++++
{DoxyConf => docs/config}/hysop.doxyfile.in | 0
{DoxyConf => docs/config}/mainpage.doxygen | 0
4 files changed, 27 insertions(+), 28 deletions(-)
delete mode 100644 README
create mode 100644 README.md
rename {DoxyConf => docs/config}/hysop.doxyfile.in (100%)
rename {DoxyConf => docs/config}/mainpage.doxygen (100%)
diff --git a/README b/README
deleted file mode 100644
index b824bdd23..000000000
--- a/README
+++ /dev/null
@@ -1,28 +0,0 @@
-
-FAQ:
-
-1. How to get only the code from the git repository?
-Create a local directory to clone into
- mkdir my_hysop && cd my_hysop
-Initialise an empty git local repository
- git init
-Configure it for sparse checkout
- git config core.sparsecheckout true
-Add the remote information
- git remote add -f origin git+ssh://<USERNAME>@scm.forge.imag.fr/var/lib/gforge/chroot/scmrepos/git/hysop/hysop.git
-Select the HySoP directory (that contains all the code)
- echo HySoP/ >> .git/info/sparse-checkout
-Get all files (only from the HySoP directory)
- git checkout master
-
-Remarks:
-Solution comes from http://stackoverflow.com/questions/4114887/is-it-possible-to-do-a-sparse-checkout-without-checking-out-the-whole-repository
-It keeps the directory/files tree as git sees all files as a single unit.
-(see http://stackoverflow.com/questions/2336580/sparse-checkout-in-git-1-7-0)
-
-
-2. How to use a single precision version ?
-Apply the patch :
- patch -p0 < utils/ToSinglePrecision.patch
-To reverse the patch:
- patch -p0 -R < utils/ToSinglePrecision.patch
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..67bd4049b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+Basics
+======
+
+Download last hysop version :
+
+code::
+
+ git clone git@gitlab.com:LJK/hysop.git
+
+build::
+
+ mkdir build
+ cd build
+ cmake path-to-hysop
+ make
+ make install
+
+
+run in python interactive session::
+
+ import hysop
+
+or using command-line::
+
+ mpirun -np 4 python yourfile.py
+
+check examples directory for complete simulation cases.
diff --git a/DoxyConf/hysop.doxyfile.in b/docs/config/hysop.doxyfile.in
similarity index 100%
rename from DoxyConf/hysop.doxyfile.in
rename to docs/config/hysop.doxyfile.in
diff --git a/DoxyConf/mainpage.doxygen b/docs/config/mainpage.doxygen
similarity index 100%
rename from DoxyConf/mainpage.doxygen
rename to docs/config/mainpage.doxygen
--
GitLab