From 512445a66f6382f7c4c0309ec452135ecbb38ae3 Mon Sep 17 00:00:00 2001 From: Michael Gielda Date: Tue, 21 Nov 2017 15:22:55 +0100 Subject: [PATCH] Update README.md for release 1.1 + link to docs --- dist/tools/renode/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/dist/tools/renode/README.md b/dist/tools/renode/README.md index 7a665e845b..d384f6208d 100644 --- a/dist/tools/renode/README.md +++ b/dist/tools/renode/README.md @@ -12,11 +12,14 @@ Packages for macOS, deb-based and rpm-based systems, for Windows and for Arch Li ### From source 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 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 From within RIOT-OS, you can use `make emulate` to start emulation. It expects a board definition file in `boards//dist/board.resc`.