Skip to content

update metadata/README for changes needed due to repo transfer #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2021
Merged

update metadata/README for changes needed due to repo transfer #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[package]
name = "tskit"
version = "0.3.0"
authors = ["molpopgen <[email protected]>"]
authors = ["tskit developers <[email protected]>"]
build = "build.rs"
edition = "2018"
description = "rust interface to tskit"
license = "MIT"
homepage = "https://github.com/molpopgen/tskit-rust"
repository = "https://github.com/molpopgen/tskit-rust"
homepage = "https://github.com/tskit-dev/tskit-rust"
repository = "https://github.com/tskit-dev/tskit-rust"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020-2021 Kevin Thornton
Copyright (c) 2020-2021 Tskit Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
38 changes: 30 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This package provides the following:

The overview is:

1. `tskit` and `kastore` source from `tskit 0.3.5` are include in `subprojects/`
1. `tskit` and `kastore` C code are include in `subprojects/`
2. These two tools are compiled into the `rust` package.
3. Then `bindgen` generates the bindings.
4. Finally, the entire rust package is generated.
Expand All @@ -26,20 +26,42 @@ Help wanted!

## Quick start guide

### Cloning the repository and running the test suite

```sh
git clone https://github.com/molpopgen/tskit_rust
cd tskit_rust
cargo build
cargo test
git clone https://github.com/tskit-dev/tskit-rust
cd tskit-rust
cargo test --all-features
```

Then, to look at the docs:
### Viewing the documentation

```
cargo doc --open
cargo doc --all-features --open
```

### Calculating code coverage

First, install `tarpaulin`:

```sh
cargo install cargo-tarpaulin
```

Then, we use all tests, doc tests, and example programs to calculate code coverage for all available features:

```sh
cargo tarpaulin --all-features --doc --tests --examples --exclude-files '*.c' --exclude-files '*.h' --ignore-tests -o html
```

Then, point your favorite browser to `tarpaulin-report.html`.

The last few flags exclude the C code and any `rust` code that is test-only from being part of the denominator of the coverage calculation.
The goal here is not to have high *test* coverage of the C API, as it is up to the [upstream project](https://github.com/tskit-dev/tskit) to provide that.

**Note:** `tarpaulin` can be fickle, and changing the order of some of those flags can cause the coverage run to fail.

## Change log

See [here](https://github.com/molpopgen/tskit_rust/blob/main/CHANGELOG.md).
See [here](https://github.com/tskit-dev/tskit-rust/blob/main/CHANGELOG.md).