doc: update README.md
This commit is contained in:
1 parent
d942163c9f
commit
6ed4c7df1c
1 file changed
+44
-4
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Quick Start Templates for **[Vue.js 3](https://vuejs.org/)** + **[Electron.js](https://www.electronjs.org/)**
|
Quick Start Templates for **[Vue 3](https://vuejs.org/)** + **[Electron.js](https://www.electronjs.org/)**
|
||||||
|
|
||||||
[](https://github.com/jooy2/vutron/blob/master/LICENSE)
|
[](https://github.com/jooy2/vutron/blob/master/LICENSE)
|
||||||

|

|
||||||
@@ -12,15 +12,24 @@ Quick Start Templates for **[Vue.js 3](https://vuejs.org/)** + **[Electron.js](h
|
|||||||

|

|
||||||
[](https://github.com/jooy2)
|
[](https://github.com/jooy2)
|
||||||
|
|
||||||
`Vutron` is a preconfigured template for developing `Electron` cross-platform desktop apps. It uses `Vue 3` and allows you to build a fast development environment with little effort.
|
**Vutron** is a preconfigured template for developing `Electron` cross-platform desktop apps. It uses `Vue 3` and allows you to build a fast development environment with little effort.
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Advantages of use
|
## Advantages of use
|
||||||
|
|
||||||
- ✅ You can build immediately without any presets, so you can develop quickly.
|
- ✅ You can build immediately without any presets, so you can develop quickly.
|
||||||
- ✅ It is being maintained quickly to be compatible with the latest `Vue` and `Electron`, as well as many modules.
|
- ✅ It is being maintained quickly to be compatible with the latest `Vue` and `Electron`, as well as many modules.
|
||||||
- ✅ There is no need to worry about layout and data management by using various additional templates.
|
- ✅ There is no need to worry about layout and data management by using various additional templates.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- ⚡️ Rapid development through hot-reload
|
||||||
|
- ⚡️ Cross-platform development and build support
|
||||||
|
- ⚡️ Multilingual support
|
||||||
|
- ⚡️ Support for themes (dark & light)
|
||||||
|
- ⚡️ Basic layout manager
|
||||||
|
- ⚡️ Global state management through the Pinia store
|
||||||
|
|
||||||
## Pre-configured components
|
## Pre-configured components
|
||||||
|
|
||||||
@@ -36,9 +45,16 @@ Quick Start Templates for **[Vue.js 3](https://vuejs.org/)** + **[Electron.js](h
|
|||||||
- [ESLint 8.x](https://eslint.org)
|
- [ESLint 8.x](https://eslint.org)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
To configure this project, the `NodeJS` version must be at least **17.1.x** or higher.
|
|
||||||
|
|
||||||
It's also experimental and relies on newer modules, with a lot of code made up of `ESM`, so it's worth checking for compatibility when using third-party modules.
|
To configure this project, the `NodeJS` version must be at least **17.1.x** or higher. (Verified and stable version is 17.1 or higher, but there doesn't seem to be any issues with NodeJS 16.16 either.)
|
||||||
|
|
||||||
|
Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
|
||||||
|
|
||||||
|
OR, Clone this repo using below command.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
|
||||||
|
```
|
||||||
|
|
||||||
After cloning the project, run the following command in the terminal:
|
After cloning the project, run the following command in the terminal:
|
||||||
|
|
||||||
@@ -54,6 +70,8 @@ $ npm run dev
|
|||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
|
Once the module installation is complete, you can simply build the platform package with the command below.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# For Windows (.exe, .appx)
|
# For Windows (.exe, .appx)
|
||||||
$ npm run build:win
|
$ npm run build:win
|
||||||
@@ -65,6 +83,28 @@ $ npm run build:mac
|
|||||||
$ npm run build:linux
|
$ npm run build:linux
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### What do I need to do for a multi-platform build?
|
||||||
|
|
||||||
|
**macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings.
|
||||||
|
|
||||||
|
You can perform multi-platform builds at once with the following command. Alternatively, you can just do it for the OS you want via the individual build commands above.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
`Multipass` configuration may be required for Linux builds. Learn more about `Multipass` through the following link: https://multipass.run/
|
||||||
|
|
||||||
|
## Looking for Electron templates made with React?
|
||||||
|
|
||||||
|
Also check out the `Retron` project, which consists of Vite + React + Material-UI + Electron.
|
||||||
|
|
||||||
|
https://github.com/jooy2/retron
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
You can report issues on [Github Issue](https://github.com/jooy2/vutron/issues). You can also request a pull to fix bugs and add frequently used features.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Copyright © 2022 Jooy2 Released under the MIT license.
|
Copyright © 2022 Jooy2 Released under the MIT license.
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user