Skip to content

Commit ddbc17a

Browse files
authored
docs(README): add note on required Rust versions
1 parent 6054985 commit ddbc17a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,13 @@ ALARM: Another Library for Allocating and Releasing Memory
66
ALARM ~is~ _will be_ the new [SOS](https://github.com/hawkw/sos-kernel) memory allocator.
77

88
**NOTE:** ALARM is currently _very_ early in the development process and most functionality has yet to be implemented.
9+
10+
11+
Building ALARM
12+
--------------
13+
14+
Building ALARM requires the [nightly Rust compiler](https://doc.rust-lang.org/book/first-edition/release-channels.html), which you can install using [`rustup`](https://www.rustup.rs/).
15+
16+
Although some components of ALARM may also be compatible with the stable Rust compiler, the core functionality of this library as a memory allocator introduces a hard dependency on the [`allocator_api`](https://github.com/rust-lang/rfcs/blob/master/text/1398-kinds-of-allocators.md) language feature, currently only available on the nightly compiler.
17+
18+
Continuous integration [builds](https://travis-ci.org/hawkw/alarm) of ALARM run against the _latest_ nightly compiler, so compatibility with older nightlies is not always assured.

0 commit comments

Comments
 (0)