Skip to content

Commit

Permalink
Update docs for no_std
Browse files Browse the repository at this point in the history
  • Loading branch information
cuviper committed Jan 14, 2020
1 parent c1bd573 commit 6f4c8d5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ extern crate num_bigint;

## Features

The `std` crate feature is mandatory and enabled by default. If you depend on
`num-bigint` with `default-features = false`, you must manually enable the
`std` feature yourself. In the future, we hope to support `#![no_std]` with
the `alloc` crate when `std` is not enabled.
The `std` crate feature is enabled by default, and is mandatory before Rust
1.36 and the stabilized `alloc` crate. If you depend on `num-bigint` with
`default-features = false`, you must manually enable the `std` feature yourself
if your compiler is not new enough.

Implementations for `i128` and `u128` are only available with Rust 1.26 and
later. The build script automatically detects this, but you can make it
Expand Down
5 changes: 5 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,11 @@
//! `std` feature yourself. In the future, we hope to support `#![no_std]` with
//! the `alloc` crate when `std` is not enabled.
//!
//! The `std` crate feature is enabled by default, and is mandatory before Rust
//! 1.36 and the stabilized `alloc` crate. If you depend on `num-bigint` with
//! `default-features = false`, you must manually enable the `std` feature yourself
//! if your compiler is not new enough.
//!
//! Implementations for `i128` and `u128` are only available with Rust 1.26 and
//! later. The build script automatically detects this, but you can make it
//! mandatory by enabling the `i128` crate feature.
Expand Down

0 comments on commit 6f4c8d5

Please sign in to comment.