Skip to content

Commit

Permalink
Fix typos (antmicro#43)
Browse files Browse the repository at this point in the history
Signed-off-by: Krzysztof Bieganski <[email protected]>
  • Loading branch information
kbieganski authored Jun 12, 2023
1 parent 298386d commit 8819fd4
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Using the default configuration, you can enable the devices you want and run com
## Parameters

### Tests configurtion
### Tests configuration

- [`renode-run`](#running-your-commands-in-emulated-linux) - A command, list or [yaml Task](#tasks) with commands to run in Renode.
- [`shared-dirs`](#shared-directories) - Shared directory paths. The contents of these directories will be mounted in Renode.
Expand All @@ -29,7 +29,7 @@ Using the default configuration, you can enable the devices you want and run com
- [`image`](#image) - URL of the path to tar.xz archive with linux rootfs for the specified architecture or docker image identifier. If not specified, the action will use the default one. See releases for examples.
- [`tasks`](#tasks) - Allows you to change the way the system is initialized. See [Tasks](#tasks) for more details.

### Borad and devices configuration
### Board and devices configuration

- [`network`](#network) - Turn on the Internet in the emulated Linux? Default: true
- [`devices`](#devices) - List of devices to add to the workflow. If not specified, the action will not install any devices.
Expand Down Expand Up @@ -324,4 +324,4 @@ The action allows you to select your own board and choose its configuration. You

- [riscv64 - hifive_unleashed](action/device/hifive_unleashed/init.resc)

You can also choose the default board: `default` or your own board: `custom`. In the latter case, you have to provide your own resc and repl files, which will conigure the emulation. Configuration files can be selected using [`resc`](https://renode.readthedocs.io/en/latest/introduction/using.html#resc-scripts) and [`repl`](https://renode.readthedocs.io/en/latest/advanced/platform_description_format.html) parameters. You can read more about these files in the [Renode documentation](https://renode.readthedocs.io/en/latest/index.html).
You can also choose the default board: `default` or your own board: `custom`. In the latter case, you have to provide your own resc and repl files, which will configure the emulation. Configuration files can be selected using [`resc`](https://renode.readthedocs.io/en/latest/introduction/using.html#resc-scripts) and [`repl`](https://renode.readthedocs.io/en/latest/advanced/platform_description_format.html) parameters. You can read more about these files in the [Renode documentation](https://renode.readthedocs.io/en/latest/index.html).
2 changes: 1 addition & 1 deletion docs/Devices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Devices

This action offers several additional devices in the default images, which are not available in the github runners, but are also not enabled by default. To enable a device simply add its name to the `devices` paremeter along with optional parameters.
This action offers several additional devices in the default images, which are not available in the GitHub runners, but are also not enabled by default. To enable a device simply add its name to the `devices` parameter along with optional parameters.

> **Warnings**
> Adding devices may not work properly with your own kernel. If you want to use your own kernel, check that you have added the correct drivers.
Expand Down
2 changes: 1 addition & 1 deletion docs/Python-packages.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pyhon packages sideloading
# Python packages sideloading

You can use the `python-packages` parameter to add the Python packages you require to test your software. This is the recommended option, as downloading packages manually in the emulated system is possible, but can sometimes fail.

Expand Down

0 comments on commit 8819fd4

Please sign in to comment.