acrn-hypervisor/misc/config_tools/configurator/README.md
Yuanyuan Zhao 5836a1bb03 config_tools: merge python packages list for configurator
Merge python packages list into one 'requirements.txt'.
And modify related document.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-01 16:51:52 +08:00

109 lines
2.2 KiB
Markdown

# ACRN Configurator
This version is based on Tauri, WIP.
## Features
### Support Platforms
- [x] Linux (.deb, AppImage)
- [x] Windows 7,8,10 (.exe, .msi)
## Setting Up
### 1. Install System Dependencies
Please follow [this guide](https://tauri.studio/docs/getting-started/prerequisites)
to install system dependencies **(including yarn)**.
#### Linux
In Linux, make sure your already install `git`, `python3`(version>=3.6) and `python3-venv` library,
```bash
$ sudo apt install git python3 python3-venv
# check python3 version
$ python3 --version
Python 3.8.10
```
#### Windows
[Chocolatey](https://chocolatey.org/) is a package manager tool for windows,
you can use `choco install xsltproc` to install `xsltproc` package,
which provide `xmllint` command.
Make sure your system have python which version>3.6,
you can check it by following command line:
```bash
$ python --version
Python 3.8.10
```
If your system doesn't have git and python, you can install it by
`choco install git python3`.
### 2. Clone Project And Install Project Dependencies.
#### Linux
```bash
git clone https://github.com/projectacrn/acrn-hypervisor
cd acrn-hypervisor/misc/config_tools/configurator
python3 -m pip install -r requirements.txt
yarn
```
#### Windows
Similar to Linux, in the Windows environment,
you need replace the command line `python3` with `python`.
### 3. How To Build
#### Linux
Run this command in the acrn-hypervisor directory.
```shell
make configurator
```
#### Windows
Run following command in the 'acrn-hypervisor' directory.
```shell
cd misc\config_tools
python scenario_config/schema_slicer.py
python scenario_config/jsonschema/convert.py
xmllint --xinclude schema/datachecks.xsd > schema/allchecks.xsd
python -m build
del configurator/packages/configurator/thirdLib/acrn_config_tools-3.0-py3-none-any.whl
cd configurator
python packages/configurator/thirdLib/manager.py install
yarn
yarn build
```
### 4. How To Run
#### Linux
Run this command in the acrn-hypervisor directory.
```shell
sudo apt install ./build/acrn-configurator_*.deb
acrn-configurator
```
#### Windows
You can find installer under the
`misc/config_tools/configurator/src-tauri/target/release/bundle/msi`
directory, the installer in the folder.