Skip to content

Commit 09c7265

Browse files
benjefferypetrelharp
authored andcommitted
Update readme for consistency across tskit-dev
1 parent 0b5f879 commit 09c7265

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# pyslim
22

3+
[![License](https://img.shields.io/github/license/tskit-dev/pyslim)](https://github.com/tskit-dev/pyslim/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/pyslim.svg)](https://pypi.org/project/pyslim/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/pyslim.svg)](https://pypi.org/project/pyslim/) [![Docs Build](https://github.com/tskit-dev/pyslim/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/pyslim/actions/workflows/docs.yml) [![Tests](https://github.com/tskit-dev/pyslim/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/pyslim/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/pyslim/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/pyslim)
4+
35
`pyslim` is a python module that provides a few extra tools for dealing with tree sequences
4-
produced by SLiM and for preparing other tree seuqences for use with SLiM.
6+
produced by SLiM and for preparing other tree sequences for use with SLiM.
57
Most tree sequence functionality is provided by [tskit](https://tskit.dev/tskit).
6-
Please see [our documentation](https://tskit.dev/pyslim/docs/stable/) for more information.
7-
(That link is to documentation for the last release release;
8+
Please see [our documentation](https://tskit.dev/pyslim/docs/stable/) ([latest](https://tskit.dev/pyslim/docs/latest/)) for more information.
9+
(That link is to documentation for the last release;
810
instead, [the latest](https://tskit.dev/pyslim/docs/latest) documentation
911
may have additional examples, but may also describe features you need to install from github to get.)
1012

@@ -14,4 +16,14 @@ To install `pyslim`, do
1416
```
1517
pip install pyslim
1618
```
17-
or read the documentation for how to [install from source](https://tskit.dev/pyslim/stable/development.html#sec-development).
19+
or read the documentation for how to [install from source](https://tskit.dev/pyslim/docs/stable/development.html#sec-development).
20+
21+
Alternatively, install from conda-forge:
22+
23+
```
24+
conda install -c conda-forge pyslim
25+
```
26+
27+
## Quickstart
28+
29+
See tutorials and examples at https://tskit.dev/pyslim/docs/stable/

0 commit comments

Comments
 (0)