Skip to content

Commit 641c0d5

Browse files
committed
update README, gitignore
1 parent d141a19 commit 641c0d5

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

Diff for: .gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Cargo.lock
2+
target/
3+

Diff for: README.md

+2-15
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# Ruster
2-
A library for creating Erlang NIFs in Rust
2+
A library for creating Erlang NIFs in Rust. A high-level Rustic API is provided. Built on [`ruster_unsafe`](https://github.com/goertzenator/ruster_unsafe).
33

44
## Status
55

6-
Not yet working.
7-
8-
I'm very close to compiling a valid immutable static ErlNifEntry, but am currently blocked by an internal compiler error. After that is fixed, some tidy-up, macrofication, and documentation should yield a useable Rust binding.
9-
10-
11-
## General Design Notes
12-
A quick note to explain what is going on here:
13-
14-
- An Erlang script generates NIF API function signatures for Rust. This roughly replicates the metaprogramming that goes on in erl_nif.h
15-
- NIF structs and datatypes are handwritten in Rust (well, actually pilfered and cleaned up from automatic bindings provided by Radosław Szymczyszyn.)
16-
- There will be a different Ruster branch for each supported version of Erlang. Just like erl_nif.h.
17-
- I've left the door open for Windows support, although this will not be the initial focus.
18-
- Since Rust has a very nice threading API, I've completely skipping the NIF threading API. It could be added later if needed.
19-
- I would like to have a low level (unsafe) API that directly maps to the C NIF API, and a higher level API that follows Rust idioms. I intend the higher level API to be zero cost or nearly zero cost.
6+
HEAVY CONSTRUCTION

0 commit comments

Comments
 (0)