diff --git a/README.md b/README.md new file mode 100644 index 0000000..4d274f4 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +

+ +RescueGUI - a simple GUI for SWUpdate in rescue mode +==================================================== + +RescueGUI is a simple GUI written in Lua with the help of the tekui +graphic toolkit (http:http://tekui.neoscientists.org/index.html). +The goal is to have a GUI for HMI devices when SWUpdate is started +in rescue mode. + +The GUI has the following goal: + +- GUI must show when an update is started from one of the interface + and displays the progress and status. +- It can initiate an install from a local storage as SD / USB +- It can provide stup for SWUpdate like network interface, etc. +- Footprint should be as small as possible to be merged into the rescue image. +- Build should be integrated in meta-swupdate + +Requirements +------------ + +- Lua interpreter > 5.2 (previous versions untested) +- tekui and luafilesystem module +- SWUpdate binding (lua-swupdate) + +Starting +-------- + +SWUpdateGUI.lua is the main program. + +Configuration +------------- + +The GUI tries to load a config.lua file at the startup. See comments in this +file to check what can be configured. + +License +------- +This project is licensed under GPL version 2.0+. + diff --git a/SWUpdate.svg b/SWUpdate.svg new file mode 100644 index 0000000..6381d38 --- /dev/null +++ b/SWUpdate.svg @@ -0,0 +1,88 @@ + + + SWUpdate Logo + + + + image/svg+xml + + SWUpdate Logo + + + + + + + + + Andres Babic <andres.babic@gmail.com> + + + + + + + + + + + + + + + + + + + +