mikros/unwinding
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Gary Guo 2021-08-26 13:30:39 +01:00
parent 370c02ac46
commit 2988ed52fb
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -5,6 +5,8 @@ This library serves two purposes:
1. Provide a pure Rust alternative to libgcc_eh or libunwind.
2. Provide easier unwinding support for `#![no_std]` targets.
Currently supports x86_64 and RV64.
## Unwinder
The unwinder can be enabled with `unwinder` feature. Here are the feature gates related to
@ -44,3 +46,8 @@ Here are the feature gates related:
| system-alloc | No | Provides a global allocator which calls `malloc` and friends. Provided for convience. |
If you are writing a `#![no_std]` program, simply enable `personality`, `panic-handler` and `system-alloc` in addition to the defaults, you instantly obtains the ability to do unwinding! An example is given in [`example/`](example).
## TODO
* A better project name!
* Remove dependencies on `alloc`.