Skip to content

Commit

Permalink
Fix crate name in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
molpopgen committed Mar 26, 2021
1 parent 28deef7 commit e9d73e4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This package provides the following:

1. Low-level bindings to the C API of both `tskit` and `kastore`.
We use [bindgen](https://docs.rs/bindgen) to automatically generate the bindings.
2. The struct `tskit_rust::TableCollection`, which wraps
2. The struct `tskit::TableCollection`, which wraps
`tsk_table_collection_t`. The wrapper is currently
incomplete, supporting only node, edge, site,
mutation, and population tables. The remaining
Expand All @@ -24,7 +24,7 @@ The overview is:
4. Finally, the entire rust package is generated.

The result is a `rust` library with all of these two C libraries statically compiled in.
Further, `rust` types and functions exist in the module name `tskit_rust::bindings`, allowing `unsafe` access to the low-level API.
Further, `rust` types and functions exist in the module name `tskit::bindings`, allowing `unsafe` access to the low-level API.

In the future, we hope to develop a more "rusty" front-end, hiding the `unsafe` bits from client code.

Expand Down

0 comments on commit e9d73e4

Please sign in to comment.