Add a basic readme and desire of the project.

This commit is contained in:
Dorian 2019-02-01 08:41:54 -05:00
commit 8e56f2c14b
5 changed files with 49 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
/target
**/*.rs.bk
Cargo.lock

7
Cargo.toml Normal file
View File

@ -0,0 +1,7 @@
[package]
name = "embedded-uptime"
version = "0.1.0"
authors = ["Dorian Pula <dorian.pula@points.com>"]
edition = "2018"
[dependencies]

13
LICENSE.md Normal file
View File

@ -0,0 +1,13 @@
Copyright 2019 Dorian Puła <dorian.pula@amber-penguin-software.ca>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Embedded Uptime
Embed a small bit of code that gets your local server uptime.
An example of a Rust library that is embeddable in Python and Web Assembly.
## Getting setup
Insure the following dependencies are in place:
* Rust v1.32+
* Python 3 Development headers (python3-dev in Ubuntu)
## Documentation
* [PyO3 Python - Rust bindings](https://pyo3.rs/master/get_started.html)
* [Setting up WebAssembly](https://www.hellorust.com/setup/wasm-target/)
* [Rust WASM book](https://rustwasm.github.io/book/introduction.html)
* [psutil](https://crates.io/crates/psutil)

7
src/lib.rs Normal file
View File

@ -0,0 +1,7 @@
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
}
}