Skip to content

Commit

Permalink
Get repo working locally and add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zacmarion-cb committed Feb 10, 2024
1 parent e845887 commit 6cf4fb8
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,26 @@ This library makes it possible to write React Native JSI modules in Rust.

For an example, check out the `example` folder.

# Contributing
## Getting Started

1. Clone this repo
2. Run `git submodule init`
3. Run `git submodule update`, this will ensure that all the vendor dependencies are cloned locally
4. Make sure you have Ninja installed locally, which is necessary for building Hermes. You can find instructions [here](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages). On macOS, you can install it with `brew install ninja`
5. Check that you can build the project with `cargo build --release`

## Contributing

I wrote this code in winter 2022 as part of another project. A few months later,
I have decided to release it to the world. However, I'm not planning to maintain
it unless I encounter another project that requires it, so for now, the code is
given to you as-is. Feel free to contribute PRs that would improve the API or
stability of the library.

# Safety
## Safety

Right now, this library is quite `unsafe`.

# Copyright / license
## Copyright / license

Copyright Ibiyemi Abiodun. MIT License.
3 changes: 1 addition & 2 deletions example/example-jsi-module/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
use jsi::{
FromObject, FromValue, IntoValue, JsiFn, JsiObject, JsiString,
PropName, RuntimeHandle, JsiValue,
host_object, FromObject, FromValue, IntoValue, JsiFn, JsiObject, JsiString, JsiValue, PropName, RuntimeHandle
};

#[cfg(target_os = "android")]
Expand Down
2 changes: 1 addition & 1 deletion jsi-tests/build.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::{env, os::unix::process::CommandExt, path::PathBuf, process::Command};
use std::{env, path::PathBuf, process::Command};

fn main() {
let pkg_base = env::var_os("CARGO_MANIFEST_DIR").unwrap();
Expand Down
Empty file modified vendor/build-hermes.sh
100644 → 100755
Empty file.

0 comments on commit 6cf4fb8

Please sign in to comment.