README.en-US.md

Multilingual README：English, 简体中文

Windows	macOS	Linux

Build Status

Build Platform	Windows	macOS	Linux
Travis CI
Azure Pipelines

Installation

Download from Github Release

You can download Wonton v1.1.2 installation package for any platform below

Platform	Architecture	Installation Package	Package
Windows	x64	.exe	.7z
macOS 10.15	x64	to be published	to be published
Ubuntu 20.04	x64	to be published	to be published

You can download Wonton v1.1.1 installation package for any platform below

Platform	Architecture	Installation Package	Package
Windows	x64	.exe	.7z
Windows (Framework Dependent)	x64	.exe	.7z
macOS 10.15	x64	.dmg	.7z
macOS 10.14	x64	.dmg	.7z
Ubuntu 20.04	x64	.deb	.7z
Ubuntu 18.04	x64	.deb	.7z
Ubuntu 16.04	x64	.deb	.7z
Ubuntu 18.04	armv7	.deb	.7z
Ubuntu 18.04	arm64	.deb	.7z

Install from Package Manager

• Windows

  If you have Chocolatey installed

  choco install wonton -y --version=1.1.1

• macOS / Linux

  Not supported yet

Architecture

Usage

Please submit an Issue upon finding a bug

Documents

Adding new devices

Compilation Guide

Dependencies

• NodeJS : https://nodejs.org/en/

  LTS and Current versions are both supported

• .NET Core SDK: https://dotnet.microsoft.com/download

  Requires .NET Core SDK version >= 3.1, please do not install Runtime versions

Compilation Steps

1. Clone the repository

   git clone https://github.com/WangyuHello/Wonton.git

2. To start compiling, run the scripts under Wonton directory

   If you did not install NodeJS or .NET Core SDK, the following script will install them automatically.

   • Windows

     • Use PowerShell

     .\build.ps1 -useMagic

     • Or use cmd

     .\build.cmd -useMagic

     • Or you can double click build.cmd file.

   • macOS、Linux

     ./build.bash -useMagic

   If you are not in mainland China, please remove the -useMagic option

3. Compiled binaries are located under Build

Driver Compilation Guide

Dependencies

Windows

• Visual Studio 2019 (MSVC 142)

macOS

• Xcode
• cmake
• autoconf
• automake
• libtool
• m4

Linux

• gcc
• cmake
• autoconf
• automake
• libtool
• m4

Compilation Steps

1. Put the NativeDeps.zip archive under the Wonton directory, and follow the steps in [Compilation Steps](##Compilation Steps)

   The source code of driver is not opensourced

2. If you want revoke driver compilation, please delete NativeDeps.zip , VLFDDriver, and SharpVLFD directories。

Troubleshoot

Can not download Electron

1. Delete Wonton.CrossUI.Web\ClientApp\node_modules\electron

2. FindElectron Cache Directory. You can create it if not exists.

   Windows： %LOCALAPPDATA%\electron\Cache
   macOS: ~/Library/Caches/electron/
   Linux: ~/.cache/electron/

3. Download Electron package from taobao mirror

   Windows： https://npm.taobao.org/mirrors/electron/11.3.0/electron-v11.3.0-win32-x64.zip
   macOS: https://npm.taobao.org/mirrors/electron/11.3.0/electron-v11.3.0-darwin-x64.zip
   Linux: https://npm.taobao.org/mirrors/electron/11.3.0/electron-v11.3.0-linux-x64.zip

4. Put the downloaded zip package into Electron Cache Directory

License

Contributors ✨

WangyuHello

GeraltShi

ImgBotApp

Hi2129