Skip to content

Commit 20af18f

Browse files
Updating README.md for a new release when this branch for improving the format command merges with master
1 parent 7dfb56b commit 20af18f

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ sequencing (RRBS). These tools focus on overcoming the computing
1212
challenges imposed by the scale of genome-wide DNA methylation data,
1313
which is usually the early parts of data analysis.
1414

15-
## Installing release 1.2.2
15+
## Installing release 1.2.3
1616

1717
The documentation for DNMTools can be found
1818
[here](https://dnmtools.readthedocs.io). But if you want to install
@@ -22,34 +22,38 @@ all the formatting.
2222

2323
### Required libraries
2424

25-
* A recent compiler: most users will be building and installing this
25+
* A recent compiler. Most users will be building and installing this
2626
software with GCC. We require a compiler that fully supports C++11,
2727
so we recommend using at least GCC 5.8. There are still many systems
2828
that install a very old version of GCC by default, so if you have
2929
problems with building this software, that might be the first thing
3030
to check.
31-
* The GNU Scientific Library: this has always been required. It can be
32-
installed using `apt` on Linux (Ubuntu, Debian), using `brew` on
33-
macOS, or from source available
31+
* The GNU Scientific Library. It can be installed using apt on Linux
32+
(Ubuntu, Debian), using brew on macOS, or from source available
3433
[here](http://www.gnu.org/software/gsl).
3534
* The Zlib compression library. Most likely you already have this
36-
installed on your system. If not, it can be installed using `apt` on
35+
installed on your system. If not, it can be installed using apt on
3736
Linux (Ubuntu, Debian) through the package `zlib1g-dev`. On macOS,
38-
Zlib can be installed with `brew`.
39-
* The HTSlib library, which can be installed through `brew` on macOS,
40-
through `apt` on Linux (Ubuntu, Debian), or from source downloadable
37+
Zlib can be installed with brew (I have not needed to install this
38+
separately on any macOS).
39+
* The HTSlib library. This can be installed through brew on macOS,
40+
through apt on Linux (Ubuntu, Debian), or from source downloadable
4141
[here](https://github.com/samtools/htslib).
4242

43+
All the above can also be installed using conda. If you use conda for
44+
these dependencies, even if you are building dnmtools from the source
45+
repo, it is easiest if all dependencies are available through conda.
46+
4347
### Configuration
4448

45-
* Download [dnmtools-1.2.2.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.2.2/dnmtools-1.2.2.tar.gz).
49+
* Download [dnmtools-1.2.3.tar.gz](https://github.com/smithlabcode/dnmtools/releases/download/v1.2.3/dnmtools-1.2.3.tar.gz).
4650
* Unpack the archive:
4751
```console
48-
tar -zxvf dnmtools-1.2.2.tar.gz
52+
tar -zxvf dnmtools-1.2.3.tar.gz
4953
```
5054
* Move into the dnmtools directory and create a build directory:
5155
```console
52-
cd dnmtools-1.2.2 && mkdir build && cd build
56+
cd dnmtools-1.2.3 && mkdir build && cd build
5357
```
5458
* Run the configuration script:
5559
```console

0 commit comments

Comments
 (0)