# Troll : Tiny Relocatable Object file format


`troll-rs` is a command to ease the process of developping (in rust) a piece of software that can be
build to a Trol file format, a lightweight, binary, relocatable code format that
can be executed from any address on an ARM Thumb architecture with flash memory.

# Installation

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 troll-rs
```


# Creating a new project

To start working on a new project, you simply have to call

```
troll-rs new PATH_TO_NEW_FOLDER
```

`troll-rs` will create your folder by cloning our template (hosted at
https://gitlab.univ-lille.fr/2xs/pip/troll-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.