Pārlūkot izejas kodu

Add instructions for usage

ticki 9 gadi atpakaļ
vecāks
revīzija
7f66ee45a0
1 mainītis faili ar 17 papildinājumiem un 0 dzēšanām
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -2,6 +2,23 @@
 
 Redox's fast & memory efficient userspace allocator.
 
+## Using ralloc
+
+Add ralloc to `Cargo.toml`:
+
+```toml
+[dependencies.ralloc]
+git = "https://github.com/redox-os/ralloc.git"
+```
+
+then import it in your main file:
+
+```rust
+extern crate ralloc;
+```
+
+`ralloc` is now ready to roll!
+
 ## Features
 
 ### Custom out-of-memory handlers