Skip to content
Snippets Groups Projects
Commit 5a709201 authored by Michael Hauspie's avatar Michael Hauspie
Browse files

Update README.md

parent 47b33970
No related branches found
No related tags found
No related merge requests found
`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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment