diff --git a/README.md b/README.md index 70cf48521c5700a3fa181e721925b9251757c4df..6f632258f3f3d1a88183859594f18760ad85d07d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -`pip-tool` is a command to ease the process of developping and -building a piece of software that can be run as a partition in the -[Pip](https://pip.univ-lille.fr) protokernel. +# Orc Relocatable Code tool + + +`orc-rs` is a command to ease the process of developping (in rust) a piece of software that can be +build to an Orc Relocatable Code file format, a lightweight, binary, relocatable code format that +can be executed from any address on an ARM Thumb architecture with flash memory. # Installation @@ -8,5 +11,20 @@ To install this software, you must have a running [Rust](https://www.rust-lang.org/learn/get-started) environnement and install it using ```sh -cargo install pip-tool +cargo install orc-rs +``` + + +# Creating a new project + +To start working on a new project, you simply have to call + +``` +orc-rs new PATH_TO_NEW_FOLDER ``` + +`orc-rs` will create your folder by cloning our template (hosted at +https://gitlab.univ-lille.fr/2xs/pip/orc-template) + +You can then have a look at the `README.md` file in the newly created folder to get the instructions +for starting your own application.