From 0c6a4fc0ba19510c3a6443f39841f090f2800815 Mon Sep 17 00:00:00 2001 From: Manuel Thalmann Date: Thu, 23 Mar 2023 13:15:51 +0100 Subject: [PATCH] Add further explanations to the `README` file --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 629a913..a579010 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # docker-keil +A docker image that allows you to run Keil uVision using Wine -A docker image that allows you to run Keil uVision using Wine \ No newline at end of file +## Usage +This docker image provides a pre-installed Wine installation with a pre-installed copy of "Keil uVision 5". +Furthermore, a command called `st-compile` is compiled which provides the functionality to build "Keil uVision 5" projects. + +The command `st-compile` accepts one parameter: + +The path to a project file or the path to a source file which belongs to a "Keil uVision 5" project (such as ASM or C source files). + +Usage: + +```bash +st-compile +``` + +This docker image can be built using the following command: + +```bash +docker build -t . +```