mirror of
https://github.com/an-anime-team/an-anime-game-launcher.git
synced 2024-11-29 18:38:48 +03:00
Readme updates
This commit is contained in:
parent
4ca47f51ca
commit
00979b5e71
3 changed files with 7 additions and 52 deletions
51
README.md
51
README.md
|
@ -1,52 +1,7 @@
|
|||
# Electron Blank Application
|
||||
<img src="logo.png">
|
||||
|
||||
This is the blank application for your electron project
|
||||
|
||||
## Requirements
|
||||
|
||||
To use Electron you must have installed node js. For windows it is available on its [official website](https://nodejs.org/en/), for linux you can download the `node` packet from your packet manager
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
git clone https://github.com/krypt0nn/electron-blank-app ./my-app
|
||||
cd my-app
|
||||
npm i
|
||||
```
|
||||
|
||||
`git clone` will download a blank bundle for your project and save it in the `./my-app` directory *(`my-app` folder in the current opened in the console directory)*
|
||||
|
||||
`cd my-app` will move you to this downloaded bundle
|
||||
|
||||
`npm i` will install requirements
|
||||
|
||||
## Set up
|
||||
|
||||
In the `package.json` you should change these parameters:
|
||||
|
||||
* name - your project name
|
||||
* version
|
||||
* description
|
||||
* keywords - your project keywords
|
||||
* author
|
||||
|
||||
## Development
|
||||
|
||||
Directory `src` stores your [TypeScript](https://typescriptlang.org) and [SASS](https://sass-lang.com) code. When you run `npm run dev` command in console - they will compile to the js and css files inside `public` directory
|
||||
|
||||
In the `public` stored information about your application - images it uses, html pages and something you want to use. Other directories will not be available in the compiled binaries
|
||||
|
||||
Default application page is `public/html/index.html`
|
||||
|
||||
To run your application - use `npm start` command. It will automatically run `npm run dev`
|
||||
|
||||
To build binaries run:
|
||||
|
||||
* For Windows: `npm run build:win`
|
||||
* For Linux: `npm run build:linux`
|
||||
|
||||
All binaries will appear in the `dist` directory
|
||||
### Launcher is still in development and is not working properly. Please, wait for future updates
|
||||
|
||||
<br>
|
||||
|
||||
Author: [Nikita Podvirnyy](https://vk.com/technomindlp)
|
||||
### Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing
|
BIN
logo.png
Normal file
BIN
logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.6 MiB |
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "genshin-impact-linux-launcher",
|
||||
"name": "an-anime-game-linux-launcher",
|
||||
"version": "0.1.0",
|
||||
"description": "Genshin Impact Linux Launcher",
|
||||
"description": "An Anime Game Linux Launcher",
|
||||
"author": "Nikita Podvirnyy",
|
||||
"license": "GPL-3.0",
|
||||
"main": "entry.js",
|
||||
|
@ -12,9 +12,9 @@
|
|||
"build:linux": "npm run dev && electron-builder --linux"
|
||||
},
|
||||
"build": {
|
||||
"productName": "Genshin Impact Linux Launcher",
|
||||
"productName": "An Anime Game Linux Launcher",
|
||||
"artifactName": "${productName}-${os}-${arch}-${version}.${ext}",
|
||||
"appId": "com.krypt0nn.genshin-impact-linux-launcher",
|
||||
"appId": "com.krypt0nn.an-anime-game-linux-launcher",
|
||||
"directories": {
|
||||
"output": "dist"
|
||||
},
|
||||
|
|
Loading…
Reference in a new issue