Skip to content

Commit 123e0e9

Browse files
azubietaazubieta
committed
Move examples to an independent section
1 parent 02e08fd commit 123e0e9

File tree

9 files changed

+282
-560
lines changed

9 files changed

+282
-560
lines changed

‎requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
recommonmark
3+
sphinx-rtd-theme

‎source/examples/bash.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
========================
2+
Shell application (BASH)
3+
========================
4+
5+
This recipe will generate a aarch64 (arm64) AppImage for bash. It's cross-built from a amd64 system.
6+
7+
.. code-block:: yaml
8+
9+
version: 1
10+
11+
AppDir:
12+
path: ./AppDir
13+
14+
app_info:
15+
id: org.gnu.bash
16+
name: bash
17+
icon: utilities-terminal
18+
version: 4.4.20
19+
exec: bin/bash
20+
exec_args: $@
21+
22+
apt:
23+
arch: arm64
24+
sources:
25+
- sourceline: 'deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports bionic main'
26+
key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3b4fe6acc0b21f32'
27+
28+
include:
29+
- bash
30+
- coreutils
31+
exclude:
32+
- libpcre3
33+
34+
35+
AppImage:
36+
update-information: None
37+
sign-key: None
38+
arch: aarch64

‎source/examples/gnome.rst

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
3+
====================================
4+
Gnome application (gnome-calculator)
5+
====================================
6+
7+
**NOTE**: If your app uses svg images you should bundle ``librsvg2-common``
8+
9+
.. code-block:: yaml
10+
11+
version: 1
12+
13+
AppDir:
14+
path: ./AppDir
15+
16+
app_info:
17+
id: org.gnome.Calculator
18+
name: gnome-calculator
19+
icon: gnome-calculator
20+
version: 3.28.0
21+
exec: usr/bin/gnome-calculator
22+
23+
apt:
24+
arch: i386
25+
sources:
26+
- sourceline: 'deb [arch=i386] http://mx.archive.ubuntu.com/ubuntu/ bionic main restricted universe multiverse'
27+
key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3b4fe6acc0b21f32'
28+
29+
include:
30+
- gnome-calculator
31+
- librsvg2-common
32+
exclude:
33+
- adwaita-icon-theme
34+
- humanity-icon-theme
35+
36+
files:
37+
exclude:
38+
- usr/lib/x86_64-linux-gnu/gconv
39+
- usr/share/man
40+
- usr/share/doc/*/README.*
41+
- usr/share/doc/*/changelog.*
42+
- usr/share/doc/*/NEWS.*
43+
- usr/share/doc/*/TODO.*
44+
45+
test:
46+
debian:
47+
image: appimagecrafters/tests-env:debian-stable
48+
command: "./AppRun"
49+
use_host_x: True
50+
centos:
51+
image: appimagecrafters/tests-env:centos-7
52+
command: "./AppRun"
53+
use_host_x: True
54+
arch:
55+
image: appimagecrafters/tests-env:archlinux-latest
56+
command: "./AppRun"
57+
use_host_x: True
58+
fedora:
59+
image: appimagecrafters/tests-env:fedora-30
60+
command: "./AppRun"
61+
use_host_x: True
62+
ubuntu:
63+
image: appimagecrafters/tests-env:ubuntu-xenial
64+
command: "./AppRun"
65+
use_host_x: True
66+
67+
68+
AppImage:
69+
arch: i686

‎source/examples/kde.rst

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
==========================
2+
Qt/Kde application (kcalc)
3+
==========================
4+
5+
.. code-block:: yaml
6+
7+
version: 1
8+
9+
AppDir:
10+
path: ./AppDir
11+
12+
app_info:
13+
id: org.kde.kcalc
14+
name: kcalc
15+
icon: accessories-calculator
16+
version: 17.12.3
17+
exec: usr/bin/kcalc
18+
19+
apt:
20+
arch: amd64
21+
sources:
22+
- sourceline: 'deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ bionic main restricted universe multiverse'
23+
key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3b4fe6acc0b21f32'
24+
- sourceline: 'deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ bionic-updates main restricted universe multiverse'
25+
- sourceline: 'deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ bionic-backports main restricted universe multiverse'
26+
27+
include:
28+
- kcalc
29+
- libpulse0
30+
exclude:
31+
- core-packages
32+
- graphics-stack-packages
33+
- xclient-packages
34+
35+
- phonon4qt5
36+
- libkf5service-bin
37+
- perl
38+
- perl-base
39+
- libpam-runtime
40+
41+
files:
42+
exclude:
43+
- usr/lib/x86_64-linux-gnu/gconv
44+
- usr/share/man
45+
- usr/share/doc/*/README.*
46+
- usr/share/doc/*/changelog.*
47+
- usr/share/doc/*/NEWS.*
48+
- usr/share/doc/*/TODO.*
49+
runtime:
50+
env:
51+
APPDIR_LIBRARY_PATH: $APPDIR/lib/x86_64-linux-gnu:$APPDIR/usr/lib/x86_64-linux-gnu:$APPDIR/usr/lib/x86_64-linux-gnu/pulseaudio
52+
53+
test:
54+
debian:
55+
image: appimagecrafters/tests-env:debian-stable
56+
command: "./AppRun"
57+
use_host_x: True
58+
env:
59+
- QT_DEBUG_PLUGINS=1
60+
centos:
61+
image: appimagecrafters/tests-env:centos-7
62+
command: "./AppRun"
63+
use_host_x: True
64+
env:
65+
- QT_DEBUG_PLUGINS=1
66+
arch:
67+
image: appimagecrafters/tests-env:archlinux-latest
68+
command: "./AppRun"
69+
use_host_x: True
70+
env:
71+
- QT_DEBUG_PLUGINS=1
72+
fedora:
73+
image: appimagecrafters/tests-env:fedora-30
74+
command: "./AppRun"
75+
use_host_x: True
76+
env:
77+
- QT_DEBUG_PLUGINS=1
78+
ubuntu:
79+
image: appimagecrafters/tests-env:ubuntu-xenial
80+
command: "./AppRun"
81+
use_host_x: True
82+
83+
84+
AppImage:
85+
update-information: None
86+
sign-key: None
87+
arch: x86_64

‎source/examples/multimedia.rst

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
============================
3+
Multimedia application (VLC)
4+
============================
5+
6+
7+
.. code-block:: yaml
8+
9+
version: 1
10+
11+
script:
12+
- rm -r ./AppDir || true
13+
14+
AppDir:
15+
path: ./AppDir
16+
17+
app_info:
18+
id: vlc
19+
name: VLC media player
20+
icon: vlc
21+
version: 3.0.8-0-gf350b6b5a7
22+
exec: usr/bin/vlc
23+
24+
apt:
25+
arch: amd64
26+
sources:
27+
- sourceline: 'deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ bionic main restricted universe multiverse'
28+
key_url: 'http://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3b4fe6acc0b21f32'
29+
- sourceline: 'deb [arch=amd64] http://archive.ubuntu.com/ubuntu/ bionic-updates main restricted universe multiverse'
30+
31+
include:
32+
- vlc
33+
34+
test:
35+
debian:
36+
image: appimagecrafters/tests-env:debian-stable
37+
command: "./AppRun"
38+
use_host_x: True
39+
centos:
40+
image: appimagecrafters/tests-env:centos-7
41+
command: "./AppRun"
42+
use_host_x: True
43+
arch:
44+
image: appimagecrafters/tests-env:archlinux-latest
45+
command: "./AppRun"
46+
use_host_x: True
47+
fedora:
48+
image: appimagecrafters/tests-env:fedora-30
49+
command: "./AppRun"
50+
use_host_x: True
51+
ubuntu:
52+
image: appimagecrafters/tests-env:ubuntu-xenial
53+
command: "./AppRun"
54+
use_host_x: True
55+
56+
AppImage:
57+
arch: x86_64

‎source/index.rst

+19-49
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ First steps
4848
intro/overview
4949
intro/install
5050
intro/tutorial
51-
intro/examples
5251

5352
:doc:`intro/overview`
5453
Understand what `appimage-builder` is and how it can help you.
@@ -59,65 +58,36 @@ First steps
5958
:doc:`intro/tutorial`
6059
Write your first `appimage-builder` recipe.
6160

62-
:doc:`intro/examples`
63-
Learn more by playing with a pre-made `appimage-builder` project.
64-
65-
===============
66-
Advanced topics
67-
===============
68-
6961
.. toctree::
70-
:caption: Advanced topics
71-
:hidden:
72-
73-
advanced/updates
74-
75-
advanced/signing
76-
77-
advanced/testing
78-
79-
advanced/troubleshooting
62+
:caption: Examples
8063

64+
examples/bash
65+
examples/gnome
66+
examples/kde
67+
examples/multimedia
8168

82-
:doc:`advanced/updates`
83-
Add delta updates support to your AppImage
69+
.. toctree::
70+
:caption: Advanced topics
71+
:hidden:
8472

85-
:doc:`advanced/signing`
86-
Sign your binaries to protect your users
73+
advanced/updates
74+
advanced/signing
75+
advanced/testing
76+
advanced/troubleshooting
8777

88-
:doc:`advanced/testing`
89-
Test in different systems
9078

91-
:doc:`advanced/troubleshooting`
92-
Find and fix issues
9379

94-
===============
95-
Hosted Services
96-
===============
9780

9881
.. toctree::
99-
:caption: Hosted Services
100-
:hidden:
101-
102-
hosted-services/gitlab-ci
103-
104-
hosted-services/github-actions
82+
:caption: Hosted Services
83+
:hidden:
10584

106-
:doc:`hosted-services/gitlab-ci`
107-
Learn how to produce AppImages on Gitlab instances
85+
hosted-services/gitlab-ci
86+
hosted-services/github-actions
10887

109-
:doc:`hosted-services/github-actions`
110-
Learn how to produce AppImages using GitHub Actions
111-
112-
====================
113-
Recipe specification
114-
====================
11588

11689
.. toctree::
117-
:caption: Recipe specification
118-
:hidden:
119-
120-
recipe/version_1
90+
:caption: Reference
91+
:hidden:
12192

122-
:doc:`recipe/version_1`
123-
Specification of the `appimage-builder` version 1 recipe format.
93+
reference/version_1

0 commit comments

Comments
 (0)