Skip to content

Commit

Permalink
Update readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
wjnjlcn committed Jan 9, 2020
1 parent 86bc9bb commit c07f82d
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,19 @@ cmake ..
make
```

The `build` directory will contain two versions of CHTKC binary files -- the normal version `chtkc` and the optimized version `chtkco`.
The `build` directory will contain two versions of CHTKC binary files:

* `chtkc`: normal version.
* `chtkco`: optimized version.

## Note

Under small RAM usage, the optimized version has better performance, because it can allocate more nodes than the normal version.

However, because the optimized version can only use up to 4G (4294967295) nodes, when the available memory is big enough, the normal version may instead allocate more nodes than the optimized the version.

For example, when counting 28-mers, if the RAM usage is over 150 GB, please consider using the normal version.
## Documentation

The documentation of CHTKC can be found [here][2].

## License

CHTKC is distributed under GNU GPL 3 license.


[1]: https://github.com/wjnjlcn/chtkc/releases
[2]: https://chtkc-doc.readthedocs.io/en/latest/

0 comments on commit c07f82d

Please sign in to comment.