Skip to content

Commit

Permalink
docs/content/quickstart.md: Updating the quickstart.md to correspond …
Browse files Browse the repository at this point in the history
…better with the README.md
  • Loading branch information
andrewdavidsmith committed Jul 23, 2024
1 parent 6fd0028 commit 925ff00
Showing 1 changed file with 22 additions and 28 deletions.
50 changes: 22 additions & 28 deletions docs/content/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,17 @@ would need to be activated when you want to use dnmtools.

### Required libraries

* A recent compiler: most users will be building and installing this
* A recent compiler. Most users will be building and installing this
software with GCC. We require a compiler that fully supports C++17,
so we recommend using at least GCC 8 (released in 2018). There are
so we recommend using at least GCC 9 (released in 2019). There are
still many systems that install a very old version of GCC by
default, so if you have problems with building this software, that
might be the first thing to check. On macOS and Ubuntu/Debian
systems, the brew and apt package managers can get you a recent
compiler easily. Any cluster or high-performance computing
environment should give you access to a recent compiler.
* The GNU Scientific Library: this has always been required. It can be
installed using apt on Linux (Ubuntu, Debian), using brew on macOS,
or from source available [here](http://www.gnu.org/software/gsl).
* The HTSlib library, which can be installed through brew on macOS,
might be the first thing to check. The clang LLVM compiler can
also be used with a recent enough version.
* The GNU Scientific Library. It can be installed using apt on Linux
(Ubuntu, Debian), using brew on macOS, or from source available
[here](http://www.gnu.org/software/gsl).
* The HTSlib library. This can be installed through brew on macOS,
through apt on Linux (Ubuntu, Debian), or from source downloadable
[here](https://github.com/samtools/htslib).
* The Zlib compression library: Most likely you already have this
Expand All @@ -72,14 +70,14 @@ would need to be activated when you want to use dnmtools.

### Configuration

* Download [dnmtools-1.4.2.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.4.2/dnmtools-1.4.2.tar.gz).
* Download [dnmtools-1.4.3.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.4.3/dnmtools-1.4.3.tar.gz).
* Unpack the archive:
```console
$ tar -zxvf dnmtools-1.4.2.tar.gz
$ tar -zxvf dnmtools-1.4.3.tar.gz
```
* Move into the dnmtools directory and create a build directory:
```console
$ cd dnmtools-1.4.2
$ cd dnmtools-1.4.3
$ mkdir build && cd build
```
* Run the configuration script:
Expand Down Expand Up @@ -119,25 +117,21 @@ $ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/path/to/htslib/lib
To test if everything was successful, simply run `dnmtools` without
any arguments and you should see the list of available commands:
```console
$ dnmtools
dnmtools
```
If you want to do more extensive tests, you can run:
There is a test suite for `dnmtools` and these test can be performed
as follows:
```console
$ make check
make check
```
from the directory where you run `make`. This will to several tests of
various commands within `dnmtools`, and might take some time.
This must be done from the build directory. Note that the tests
performed with `make check` are mostly regression tests that cover
prior issues rather than coverage tests to test all the functionality
of `dnmtools`.

## Using a clone of the repo

*This option is deprecated; we are no longer maintaining a Makefile
that is not generated by `./configure`.* Not recommended, but if you
want to do it this way, we assume you know what you are doing. We
strongly recommend using dnmtools through the latest stable release
We strongly recommend using dnmtools through the latest stable release
under the releases section on GitHub. Developers who wish to work on
the latest commits, which are unstable, can compile the source using
the `Makefile` available in the root of the source tree. If HTSLib and
other libraries are available system-wide, compile by running:
```console
$ make
```
the latest commits, which are unstable, can start the process using
the `autogen.sh` script and then using the usual autotools approach.

0 comments on commit 925ff00

Please sign in to comment.