https://github.com/jesus89/grunt-appimage
Grunt task to create AppImages
https://github.com/jesus89/grunt-appimage
appimage grunt grunt-task gruntjs
Last synced: 3 months ago
JSON representation
Grunt task to create AppImages
- Host: GitHub
- URL: https://github.com/jesus89/grunt-appimage
- Owner: Jesus89
- License: gpl-2.0
- Created: 2017-03-04T11:50:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-29T22:40:09.000Z (about 8 years ago)
- Last Synced: 2025-01-21T22:44:33.226Z (5 months ago)
- Topics: appimage, grunt, grunt-task, gruntjs
- Language: JavaScript
- Size: 406 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-appimage [](https://travis-ci.org/Jesus89/grunt-appimage)
> Grunt task to create AppImages.
A simple way to automate the creation of GNU/Linux AppImages (http://appimage.org).
[](https://nodei.co/npm/grunt-appimage/)
## Install
```
$ npm install grunt-appimage --save-dev
```
## Usage
```js
grunt.initConfig({
appimage: {
myapp: {
options: {
name: 'MyApp',
exec: 'myapp',
arch: '64bit',
icons: 'path/to/icons',
comment: 'Awesome App',
archive: 'path/to/MyApp.AppImage'
install: true
},
files: [{
src: 'path/to/myapp'
}]
}
}
});
```
## Files
Standard grunt files. [More information](https://gruntjs.com/configuring-tasks#files).
## Options
#### name
*Required*
Type: `String`
Application name.
#### exec
*Required*
Type: `String`
Executable file path.
#### arch
Type: `String`
Default: `64bit`
AppImage architecture: `32bit`, `64bit`.
#### icons
Type: `String`
Default: ``
Icons path. [More information](https://github.com/Jesus89/grunt-appimage/wiki/Create-icons).
#### comment
Type: `String`
Default: ``
Comments about the application.
#### archive
*Required*
Type: `String` `Function`
Mode: `AppImage`
This is used to define where to output the archive. Each target can only have one output file. If the type is a Function it must return a String.
#### install
Type: `Boolean`
Default: `true`
This flag enables an installation message when the AppImage is launched to install the application (desktop launch and icons).
## Examples
```js
grunt.initConfig({
appimage: {
myapp: {
options: {
name: 'MyApp'
exec: 'myapp',
archive: 'dist/MyApp.AppImage'
},
src: 'dist/MyApp/myapp'
}
}
});
```
```js
grunt.initConfig({
appimage: {
myapp32: {
options: {
name: 'MyApp'
exec: 'app',
arch: '32bit'
archive: 'dist/MyApp-32.AppImage'
},
files: [{
src: 'dist/MyApp/*'
}]
},
myapp64: {
options: {
name: 'MyApp'
exec: 'app',
arch: '64bit'
archive: 'dist/MyApp-64.AppImage'
},
files: [{
src: 'dist/MyApp/*'
}]
}
}
});
```
```js
grunt.initConfig({
appimage: {
myapp: {
options: {
name: 'MyApp'
exec: 'app',
icons: 'res/icons',
comment: 'Awesome App',
archive: 'dist/MyApp.AppImage',
install: false
},
files: [
{src: 'dist/MyApp/*', dot: true},
{src: 'dist/extra/*', dest: 'extra/', filter: 'isFile'}
]
}
}
});
```