README.md 1.5 KB
Newer Older
Jeremy Soller's avatar
Jeremy Soller committed
1
2
3
# orbclient
The Orbital Client Library. Compatible with Redox and SDL2.

Florian Blasius's avatar
Florian Blasius committed
4
[![Build status](https://gitlab.redox-os.org/redox-os/orbclient/badges/master/pipeline.svg)](https://gitlab.redox-os.org/redox-os/orbclient/pipelines)
Jeremy Soller's avatar
Jeremy Soller committed
5
6
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![crates.io](http://meritbadge.herokuapp.com/orbclient)](https://crates.io/crates/orbclient)
Jeremy Soller's avatar
Jeremy Soller committed
7
[![docs.rs](https://docs.rs/orbclient/badge.svg)](https://docs.rs/orbclient)
Jeremy Soller's avatar
Jeremy Soller committed
8

Florian Blasius's avatar
Wasm    
Florian Blasius committed
9
10
11
12
13
14
15
16
17
18
19
20
## Platform notes 

### Web

* Rust standard toolchain `rustup`, `rustc`, `cargo` ([install](https://www.rust-lang.org/tools/install))
* Rust web assembly toolchain `wasm-pack` ([install](https://rustwasm.github.io/wasm-pack/installer/))
* JavaScript package manager npm ([install](https://www.npmjs.com/get-npm))
* Run simple example
  * Navigate to `examples/simple` director
  * Run `npm install`
  * Run `npm run serve`

k0pernicus's avatar
k0pernicus committed
21
22
23
### Troubleshooting

* Make sure that you work with the current ```nightly``` version of Rust
Ian Douglas Scott's avatar
Ian Douglas Scott committed
24
  * To make sure of that, please use [rustup](https://github.com/rust-lang-nursery/rustup.rs)
25
26
  * Don't forget to override your work directory with ```rustup override set nightly```
  * Don't forget to update the ```nightly``` version of Rust with ```rustup update nightly```
Florian Blasius's avatar
Florian Blasius committed
27
* SDL2 should be automatically with orbclient if you have trouble try to install it ```libsdl2-dev``` manually   
k0pernicus's avatar
k0pernicus committed
28
29
  * For example, with Ubuntu, please to type ```sudo apt-get install libsdl2-dev``` in your console
* Other problem? Do not hesitate to create a new issue!