-
Notifications
You must be signed in to change notification settings - Fork 2
/
how_to_use.txt
52 lines (34 loc) · 1.36 KB
/
how_to_use.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Installation:
1. Clone this repository to your local machine:
```
git clone https://github.com/Johoski/WebToApp.git
cd WebToApp
```
2. Install the required dependencies:
- Python packages:
```
pip install -r requirements.txt
```
- `nativefier`:
```
npm install nativefier -g
```
- `appimagetool` and `appimagelint` binaries:
The script expects the following files to be present in the `dependencies` directory if not they are gonna be downloaded automatically:
- `appimagetool-x86_64.AppImage` [Download from: AppImageKit Releases](https://github.com/AppImage/AppImageKit/releases)
- `appimagelint-x86_64.AppImage` [Download from: AppImageLint Releases](https://github.com/TheAssassin/appimagelint/releases)
Usage:
1. Open a terminal and navigate to the cloned repository:
```
cd WebToApp
```
2. Run the script with the desired options:
```
python main.py -a app_name --noclean --lint
```
Available options:
- `-a, --app`: Specify the name of the app in the configuration file.
- `--noclean`: Skip cleaning the source and temporary folders after building the AppImage.
- `--lint`: Perform linting on the created AppImage.
3. Follow the script's output and prompts for any additional actions or inputs required.
4. Once the script finishes, the generated AppImage file will be available in the output directory.