From 9ee563fc2e27b9a22ea6f384deec099cb9e7daf3 Mon Sep 17 00:00:00 2001 From: paradajz <2544094+paradajz@users.noreply.github.com> Date: Sun, 1 Oct 2023 22:54:16 +0200 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 01e456a..a6695b7 100755 --- a/README.md +++ b/README.md @@ -14,9 +14,16 @@ The configurator is always available online via [this link](https://config.shant ## Development -This project uses Vue, Vite, Tailwind and Typescript. For development usage, make sure `yarn` command is installed. After that, development version of the configurator with local server can be started with the following commands: +This projects uses Docker container for development. To use it, run the following command from the root repository directory: -``` -yarn -yarn dev -``` \ No newline at end of file + ./scripts/dev.sh + +The development version of the configurator with local server can be started with the following commands: + + make + +To package the configuration for offline usage, run the following command: + +* Linux: `make pkg PLATFORM=linux` +* Windows: `make PLATFORM=win32` +* macOS: `make PLATFORM=darwin` \ No newline at end of file