mirror of
https://github.com/kusti8/proton-native.git
synced 2026-05-15 22:02:24 -06:00
35 lines
676 B
Markdown
35 lines
676 B
Markdown
# Quickstart
|
|
|
|
## Prerequisites
|
|
|
|
### Linux
|
|
|
|
`libgtk-3-dev build-essential`
|
|
|
|
## Install
|
|
|
|
### Automatic
|
|
|
|
If you're on Windows, you may need to install `windows-build-tools` to compile libui-node correctly.
|
|
|
|
```bash
|
|
# install the cli app
|
|
npm install -g create-proton-app
|
|
# create your project
|
|
create-proton-app my-app
|
|
# move to your project directory
|
|
cd my-app
|
|
# run your app
|
|
npm run start
|
|
```
|
|
|
|
You can alternatively use `npx` if you prefer.
|
|
|
|
### Manual
|
|
|
|
The old manual instructions are still available [here](manual_install.md)
|
|
|
|
## Optional Extras
|
|
|
|
If you love using TypeScript, thanks to the efforts of @khanhas, typings
|
|
are provided through the `@types/proton-native` package.
|