Commit 286400a3 authored by Jógvan Magnus Haugaard Olsen's avatar Jógvan Magnus Haugaard Olsen
Browse files

Update README

parent d3165798
Pipeline #117050412 canceled with stage
in 30 minutes and 6 seconds
[![pipeline status](https://gitlab.com/dalton/dalton/badges/master/pipeline.svg)](https://gitlab.com/dalton/dalton/pipelines)
[![coverage report](https://gitlab.com/dalton/dalton/badges/master/coverage.svg?job=nightly-coverage)](https://gitlab.com/dalton/dalton/pipelines)
Nightly runs on full testset: https://testboard.org/cdash/index.php?project=Dalton
## Dalton links
- [Home page](http://daltonprogram.org/)
- [Forum](http://forum.daltonprogram.org/)
- [Article](http://onlinelibrary.wiley.com/doi/10.1002/wcms.1172/abstract)
## Quick start
Note that it is currently not practical to download the source using the
download button on GitLab, because it will not include the submodules that are
required to build Dalton. Instead you should clone the repository as described
below.
Clone the repository:
```
$ git clone --recursive https://gitlab.com/dalton/dalton.git
......@@ -18,22 +27,30 @@ checkout a specific release version, run the following commands from inside the
$ git checkout Dalton2018.0
$ git submodule update
```
replacing *Dalton2018.0* by the release version that you are interesed in. Note
that it is currently not possible to fetch all past releases.
where you replace *Dalton2018.0* by the release version that you are
interested in. The list of past releases available in this repository can be
found here: https://gitlab.com/dalton/dalton/-/tags.
To build the code:
In case you did not include the `--recursive` argument when you cloned the
repository, it is necessary to run the following two commands:
```
$ git submodule init
$ git submodule update --recursive
```
To build the code, perform the following steps:
```
$ ./setup [--help]
$ cd build
$ make [-j4]
```
Run the test set:
Once the build is complete, you can run the test set as:
```
$ ctest [-j4]
```
To switch branch, run the following two commands from the *dalton* directory:
To switch branch (or release tag), run the following two commands from the *dalton* directory:
```
$ git checkout feature-branch
$ git submodule update
......@@ -42,27 +59,3 @@ This can also be achieved in one step when you clone the repository:
```
$ git clone --recursive -b feature-branch https://gitlab.com/dalton/dalton.git
```
In case you did not include the `--recursive` argument when you cloned the
repository, it is necessary to run the following two commands from the *dalton*
directory before entering the *build* directory and running `make`:
```
$ git submodule init
$ git submodule update --recursive
```
Note that it is currently not practical to download the source using the
download button on GitLab, because it will not include the submodules that are
required to build Dalton. Instead you should clone the repository as described
above.
## How to contribute
See Dalton Developer’s Guide: http://dalton-devguide.readthedocs.io
## Dalton links
- [Home page](http://daltonprogram.org/)
- [Forum](http://forum.daltonprogram.org/)
- [Article](http://onlinelibrary.wiley.com/doi/10.1002/wcms.1172/abstract)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment