zfc

Library for sets according to ZFC.
git clone https://git.philomathiclife.com/repos/zfc
Log | Files | Refs | README

README.md (2294B)

      1 # `zfc`
      2 
      3 [<img alt="git" src="https://git.philomathiclife.com/badges/zfc.svg" height="20">](https://git.philomathiclife.com/zfc/log.html)
      4 [<img alt="crates.io" src="https://img.shields.io/crates/v/zfc.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/zfc)
      5 [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-zfc-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/zfc/latest/zfc/)
      6 
      7 `zfc` is a library for sets according to
      8 [Zermelo–Fraenkel set theory with the axiom of choice (ZFC)](https://en.wikipedia.org/wiki/Zermelo%E2%80%93Fraenkel_set_theory).
      9 
     10 ## Minimum Supported Rust Version (MSRV)
     11 
     12 This will frequently be updated to be the same as stable. Specifically, any time stable is updated and that
     13 update has "useful" features or compilation no longer succeeds (e.g., due to new compiler lints), then MSRV
     14 will be updated.
     15 
     16 MSRV changes will correspond to a SemVer patch version bump pre-`1.0.0`; otherwise a minor version bump.
     17 
     18 ## SemVer Policy
     19 
     20 * All on-by-default features of this library are covered by SemVer
     21 * MSRV is considered exempt from SemVer as noted above
     22 
     23 ## License
     24 
     25 Licensed under either of
     26 
     27 * Apache License, Version 2.0 ([LICENSE-APACHE](https://www.apache.org/licenses/LICENSE-2.0))
     28 * MIT license ([LICENSE-MIT](https://opensource.org/licenses/MIT))
     29 
     30 at your option.
     31 
     32 ## Contribution
     33 
     34 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
     35 as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
     36 
     37 Before any PR is sent, `cargo clippy --all-targets`, `cargo test --all-targets`, and `cargo test --doc` should be
     38 run _for each possible combination of "features"_ using the stable and MSRV toolchains. One easy way to achieve this
     39 is by invoking [`ci-cargo`](https://crates.io/crates/ci-cargo) as `ci-cargo clippy --all-targets test --all-targets`
     40 in the `zfc` directory.
     41 
     42 Last, `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features` should be run to ensure documentation can be
     43 built.
     44 
     45 ### Status
     46 
     47 The crate is only tested on the `x86_64-unknown-linux-gnu`, `x86_64-unknown-openbsd`, and `aarch64-apple-darwin`
     48 targets; but it should work on most platforms.