Commit ed9804f9 authored by Mick Michalski's avatar Mick Michalski
Browse files

Updated the README file formatting

parent cfaa8b8d
......@@ -55,24 +55,24 @@ to bypass changes from your mailer.
## Gateway Update Instructions:
1. When the gateway is first started, you will need to update the config file at `/etc/gateway.conf`, with the proper settings for your servers. Any file system updates should contain a new, properly configured `gateway.conf` file along with the updates. Reboot the gateway to implement the changes.
1: When the gateway is first started, you will need to update the config file at `/etc/gateway.conf`, with the proper settings for your servers. Any file system updates should contain a new, properly configured `gateway.conf` file along with the updates. Reboot the gateway to implement the changes.
2. When creating an update for the gateway, include one of the following lua scripts in your `sw-description` file:
2: When creating an update for the gateway, include one of the following lua scripts in your `sw-description` file:
- `prepost-k.lua` (if updating the kernel)
- `prepost-fs.lua` (if updating the file system)
- `prepost-kfs.lua` (if updating both the kernel and filesystem)
- `prepost-k.lua` (if updating the kernel)
- `prepost-fs.lua` (if updating the file system)
- `prepost-kfs.lua` (if updating both the kernel and filesystem)
These Lua scripts call applications on the installed system that prepare the system for install. After a successful install, they will update the system to boot into the newly updated partitions.
These Lua scripts call applications on the installed system that prepare the system for install. After a successful install, they will update the system to boot into the newly updated partitions.
You can find examples of how to include these scripts in your `sw-description` file below.
You can find examples of how to include these scripts in your `sw-description` file below.
3. Set the installation device to one of the following:
3: Set the installation device to one of the following:
- `/dev/dev-k` (for the kernel)
- `/dev/dev-fs` (for the filesystem)
- `/dev/dev-k` (for the kernel)
- `/dev/dev-fs` (for the filesystem)
These are the devices that are referenced in the `sw-description` file. They will be created by the applications that the Lua scripts execute. See the examples below for how to set these in your updates.
These are the devices that are referenced in the `sw-description` file. They will be created by the applications that the Lua scripts execute. See the examples below for how to set these in your updates.
### Example sw-description files:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment