From 8e56f2c14bd09e6b2d0c7e88cb7670ff19d37b96 Mon Sep 17 00:00:00 2001 From: Dorian Pula Date: Fri, 1 Feb 2019 08:41:54 -0500 Subject: [PATCH] Add a basic readme and desire of the project. --- .gitignore | 3 +++ Cargo.toml | 7 +++++++ LICENSE.md | 13 +++++++++++++ README.md | 19 +++++++++++++++++++ src/lib.rs | 7 +++++++ 5 files changed, 49 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6936990 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..5a4b1a3 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,7 @@ +[package] +name = "embedded-uptime" +version = "0.1.0" +authors = ["Dorian Pula "] +edition = "2018" + +[dependencies] diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2cf30b0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,13 @@ +Copyright 2019 Dorian Puła + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9ce6bce --- /dev/null +++ b/README.md @@ -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) diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..31e1bb2 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,7 @@ +#[cfg(test)] +mod tests { + #[test] + fn it_works() { + assert_eq!(2 + 2, 4); + } +}