Update how to get started and develop

snek5000 · Nov 26, 2019 · e5a85fb · e5a85fb
1 parent 336cc5a
commit e5a85fb
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,19 @@
 # General guidelines
 
-* Use an editor which supports [EditorConfig](http://editorconfig.org/)
-* Follow [Fortran best practices](https://www.fortran90.org/src/best-practices.html)
+
+* **Editor**: Use an editor which supports [EditorConfig](http://editorconfig.org/)
+* **Style guide**: Follow [Fortran best practices](https://www.fortran90.org/src/best-practices.html)
+* **Branching model**: The development uses branches and pull-requests for experimental features. We
+  also rely on [git submodules](https://www.git-scm.com/docs/git-submodule) to
+  track other libraries. The following branches are important:
+
+  * `eturb`:
+    * `master`: main branch
+    * `develop`: development branch
+  * `lib/Nek5000`:
+    * `master`: upstream branch
+    * `stable`: main branch tracking the stable version 17
+    * `develop`: development branch
 
 ## Vim
 

diff --git a/README.md b/README.md
@@ -1,2 +1,34 @@
 # eturb
-Efficient simulations of atmospheric boundary layer
+Efficient simulations of turbulent atmospheric boundary layer.
+
+## Getting started
+
+```sh
+# Clone
+git clone --recursive [email protected]:exabl/eturb.git
+
+# Activate paths: Start here. Always!
+cd eturb
+source activate.sh
+
+# Build Nek5000
+cd lib/Nek5000/tools/
+./maketools all
+cd -
+
+# Build case
+cd src/abl_nek5000/
+makenek
+cd -
+
+# Run case
+cd src/abl_nek5000/
+nekmpi <nb_procs> # foreground
+nekbmpi <nb_procs> # background
+cd -
+
+```
+
+## Development
+
+See [contributing guidelines](CONTRIBUTING.md).
diff --git a/activate.sh b/activate.sh
@@ -0,0 +1,2 @@
+DIR="$(pwd)"
+export SOURCE_ROOT="$DIR/eturb/lib/Nek5000"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		DIR="$(pwd)"
		export SOURCE_ROOT="$DIR/eturb/lib/Nek5000"