Skip to content

Commit edc8849

Browse files
committed
update of the README
1 parent 82f2fab commit edc8849

1 file changed

Lines changed: 3 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
[![Install with Bioconda](https://anaconda.org/bioconda/poseidon-trident/badges/version.svg)](https://anaconda.org/bioconda/poseidon-trident) [![Anaconda-Server Badge](https://anaconda.org/bioconda/poseidon-trident/badges/downloads.svg)](https://anaconda.org/bioconda/poseidon-trident)
55

66
# poseidon-hs
7-
A toolset to work with modular genotype databases formatted using Poseidon. The main executable within this package is called `trident`.
7+
A toolset to work with modular genotype databases formatted using Poseidon. The main executables within this package are called `trident` and `xerxes`.
88

9-
**Detailed user documentation can be found on our [website](https://poseidon-framework.github.io/#/trident).**
9+
**Detailed user documentation can be found on our website for [trident](https://poseidon-framework.github.io/#/trident) and [xerxes](https://poseidon-framework.github.io/#/xerxes).**
1010

1111
***
1212

@@ -19,16 +19,7 @@ To install the development version of poseidon-hs/trident you can follow these s
1919
3. Execute `stack install` inside the repository to build the tool and copy the executables to `~/.local/bin` (which you may want to add to your path). This will install the compiler and all dependencies into folders that won't interfere with any installation you might already have.
2020
4. To run the tests, execute `stack test` inside the repository to build and run tests.
2121

22-
### Development Quickstart
23-
24-
The technical haddock documentation for the poseidon-hs Haskell library is available [here](https://poseidon-framework.github.io/poseidon-hs/index.html) (you can also render it locally using `stack haddock` and open it subsequently using `stack haddock --open`). The critical package is the `Poseidon.Core.Package` module which defines the core functions to read and work with module files.
25-
26-
Important packages to look into to understand the architecture of this tool:
27-
28-
* Start with `Poseidon.Core.Package`: It defines the main package format and provides some functions how to access the data inside packages.
29-
* The `Poseidon.Core.Utils` module only provides the definition of an Exception type.
30-
* The modules in `CLI/` define the functionality provided in the command line functions for `trident`.
31-
* The `list` command might be a good place to start understanding what's going on and how to use the `Poseidon.Core.Package` interface.
22+
The technical haddock documentation for the poseidon-hs Haskell library is available [here](https://poseidon-framework.github.io/poseidon-hs/index.html) (you can also render it locally using `stack haddock` and open it subsequently using `stack haddock --open`).
3223

3324
### Preparing a new stable release
3425

0 commit comments

Comments
 (0)