Files
acrn-hypervisor/misc/config_tools/configurator/README.md
Yang,Yu-chu c17c8e321c config-tools: fix typos of UI and README
1. In the title "Create a new Scenario", capitalize the "N" in "new".
2. Fix the file path to the installer.

Tracked-On: #8137
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
Reviewed-by: Junjie Mao <junjie.mao@intel.com>
2022-09-14 08:44:57 +08:00

110 lines
2.4 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
1. Please follow [this guide](https://tauri.studio/v1/guides/getting-started/prerequisites)
to install system dependencies.
2. Download and install [Nodejs](https://nodejs.org/en/download/).
3. Please follow [this guide](https://yarnpkg.com/lang/en/docs/install/) to install 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\converter.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\packages\configurator\src-tauri\target\release\bundle\msi`
directory, the installer in the folder.