riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md for release 1.1 + link to docs

Browse Source
This commit is contained in:
Michael Gielda 2017-11-21 15:22:55 +01:00 committed by GitHub
parent 0ca4f4252a
commit 512445a66f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
dist/tools/renode/README.md vendored
View File

@ -12,11 +12,14 @@ Packages for macOS, deb-based and rpm-based systems, for Windows and for Arch Li
### From source ### From source
Follow the installation instructions on Renode's [GitHub](https://github.com/renode/renode#installation) page. Follow the installation instructions on Renode's [GitHub](https://github.com/renode/renode#installation) page.
After compilation is successful, ensure that `renode` is available on your `PATH`. One way to do so, is via symlink: `sudo ln -s path/to/renode/repository/run.sh /usr/local/bin/renode`. After compilation is successful, ensure that `renode` is available on your `PATH`. One way to do so, is via symlink: `sudo ln -s path/to/renode/repository/renode /usr/local/bin/renode`.
### Testing ### Testing
After installation, verify if Renode is working using `renode --help`. You should be presented with a help screen. After installation, verify if Renode is working using `renode --help`. You should be presented with a help screen.
## Documentation
Documentation for Renode can be found on [Read The Docs](https://renode.readthedocs.io).
## Usage ## Usage
From within RIOT-OS, you can use `make emulate` to start emulation. It expects a board definition file in `boards/<BOARD>/dist/board.resc`. From within RIOT-OS, you can use `make emulate` to start emulation. It expects a board definition file in `boards/<BOARD>/dist/board.resc`.