README.md
1# ACRN Configurator
2
3This version is based on Tauri, WIP.
4
5## Features
6
7### Support Platforms
8
9- [x] Linux (.deb, AppImage)
10- [x] Windows 7,8,10 (.exe, .msi)
11
12## Setting Up
13
14### 1. Install System Dependencies
15
161. Please follow [this guide](https://tauri.studio/v1/guides/getting-started/prerequisites)
17to install system dependencies.
182. Download and install [Nodejs](https://nodejs.org/en/download/).
193. Please follow [this guide](https://yarnpkg.com/lang/en/docs/install/) to install yarn.
20
21#### Linux
22
23In Linux, make sure your already install `git`, `python3`(version>=3.6) and `python3-venv` library,
24
25```bash
26$ sudo apt install git python3 python3-venv
27# check python3 version
28$ python3 --version
29Python 3.8.10
30```
31
32#### Windows
33
34[Chocolatey](https://chocolatey.org/) is a package manager tool for windows,
35you can use `choco install xsltproc` to install `xsltproc` package,
36which provide `xmllint` command.
37
38Make sure your system have python which version>3.6,
39you can check it by following command line:
40
41```bash
42$ python --version
43Python 3.8.10
44```
45
46If your system doesn't have git and python, you can install it by
47`choco install git python3`.
48
49### 2. Clone Project And Install Project Dependencies.
50
51#### Linux
52
53```bash
54git clone https://github.com/projectacrn/acrn-hypervisor
55cd acrn-hypervisor/misc/config_tools/configurator
56python3 -m pip install -r requirements.txt
57yarn
58```
59
60#### Windows
61
62Similar to Linux, in the Windows environment,
63you need replace the command line `python3` with `python`.
64
65### 3. How To Build
66
67#### Linux
68
69Run this command in the acrn-hypervisor directory.
70
71```shell
72make configurator
73```
74
75#### Windows
76
77Run following command in the 'acrn-hypervisor' directory.
78
79```shell
80cd misc\config_tools
81python scenario_config\schema_slicer.py
82python scenario_config\jsonschema\converter.py
83xmllint --xinclude schema\datachecks.xsd > schema\allchecks.xsd
84
85python -m build
86del configurator\packages\configurator\thirdLib\acrn_config_tools-3.0-py3-none-any.whl
87
88cd configurator
89python packages\configurator\thirdLib\manager.py install
90yarn
91yarn build
92```
93
94### 4. How To Run
95
96#### Linux
97
98Run this command in the acrn-hypervisor directory.
99
100```shell
101sudo apt install ./build/acrn-configurator_*.deb
102acrn-configurator
103```
104
105#### Windows
106
107You can find installer under the
108`misc\config_tools\configurator\packages\configurator\src-tauri\target\release\bundle\msi`
109directory, the installer in the folder.
110