Skip to content

Commit 704f928

Browse files
gcclinuxgcclinux
committed
created flatpak file
1 parent a060a50 commit 704f928

File tree

9 files changed

+463
-1
lines changed

9 files changed

+463
-1
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
/build/
1010
/classes/
1111
/artifacts/
12+
.flatpak-builder
13+
/flatpak-repo/
1214

1315
# IntelliJ IDEA
1416
/.idea/

‎docs/README-flatpak.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
layout: default
3+
title: Flatpak Build Instructions
4+
description: How to build SmallTextPad as a Flatpak package from source
5+
---
6+
7+
# SmallTextPad Flatpak Build Instructions
8+
9+
This guide explains how to build SmallTextPad as a Flatpak package from source.
10+
11+
## Prerequisites
12+
13+
### Install pre-requisite flatpakrepo & flatpak-builder
14+
15+
```bash
16+
$ flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
17+
```
18+
19+
```bash
20+
$ flatpak install org.flatpak.Builder
21+
```
22+
23+
## Download the Flatpak Manifest
24+
25+
#### Download the io.github.gcclinux.smalltextpad.yml
26+
27+
[https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml](https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml)
28+
29+
```bash
30+
$ curl -O https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml
31+
```
32+
33+
## Build Process
34+
35+
### Build the Flatpak
36+
37+
Use the flatpak-builder command to build the package:
38+
39+
```bash
40+
$ flatpak-builder --force-clean --user --install-deps-from=flathub --repo=repo builddir io.github.gcclinux.smalltextpad.yml
41+
```
42+
43+
### Export the Flatpak Package
44+
45+
After the build is complete, export the package to a file:
46+
47+
```bash
48+
$ flatpak build-export repo builddir
49+
```
50+
51+
### Create the Flatpak File
52+
53+
Use the flatpak build-bundle command to create the .flatpak file:
54+
55+
```bash
56+
$ flatpak build-bundle repo SmallTextPad-1.5.1.flatpak io.github.gcclinux.smalltextpad
57+
```
58+
59+
### Install the Created File
60+
61+
```bash
62+
$ flatpak install --user SmallTextPad-$(arch)-1.5.1.flatpak
63+
```
64+
65+
## Running SmallTextPad
66+
67+
After installation, you can run SmallTextPad from your application menu or via command line:
68+
69+
```bash
70+
$ flatpak run io.github.gcclinux.smalltextpad
71+
```
72+
73+
## Notes
74+
75+
- The Flatpak includes all necessary Java runtime dependencies
76+
- SmallTextPad will have access to your home directory, documents, desktop, and downloads folders
77+
- The application supports both X11 and Wayland display servers
78+
- All encryption, multi-language support, and core features are included in the Flatpak build

‎docs/_site/README-flatpak.html‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<meta charset="UTF-8">
5+
6+
<!-- Begin Jekyll SEO tag v2.8.0 -->
7+
<title>Flatpak Build Instructions | SmallTextPad</title>
8+
<meta name="generator" content="Jekyll v4.4.1" />
9+
<meta property="og:title" content="Flatpak Build Instructions" />
10+
<meta name="author" content="Ricardo Wagemaker" />
11+
<meta property="og:locale" content="en_US" />
12+
<meta name="description" content="How to build SmallTextPad as a Flatpak package from source" />
13+
<meta property="og:description" content="How to build SmallTextPad as a Flatpak package from source" />
14+
<link rel="canonical" href="http://localhost:4000/README-flatpak.html" />
15+
<meta property="og:url" content="http://localhost:4000/README-flatpak.html" />
16+
<meta property="og:site_name" content="SmallTextPad" />
17+
<meta property="og:type" content="website" />
18+
<meta name="twitter:card" content="summary" />
19+
<meta property="twitter:title" content="Flatpak Build Instructions" />
20+
<script type="application/ld+json">
21+
{"@context":"https://schema.org","@type":"WebPage","author":{"@type":"Person","name":"Ricardo Wagemaker"},"description":"How to build SmallTextPad as a Flatpak package from source","headline":"Flatpak Build Instructions","url":"http://localhost:4000/README-flatpak.html"}</script>
22+
<!-- End Jekyll SEO tag -->
23+
24+
<link rel="preconnect" href="https://fonts.gstatic.com">
25+
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
26+
<meta name="viewport" content="width=device-width, initial-scale=1">
27+
<meta name="theme-color" content="#157878">
28+
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
29+
<link rel="stylesheet" href="/assets/css/style.css?v=">
30+
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
31+
32+
<!-- Setup Google Analytics -->
33+
34+
35+
36+
<!-- You can set your favicon here -->
37+
<!-- link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" -->
38+
39+
<!-- end custom head snippets -->
40+
41+
</head>
42+
<body>
43+
<a id="skip-to-content" href="#content">Skip to the content.</a>
44+
45+
<header class="page-header" role="banner">
46+
<h1 class="project-name">Flatpak Build Instructions</h1>
47+
<h2 class="project-tagline">How to build SmallTextPad as a Flatpak package from source</h2>
48+
49+
50+
<a href="" class="btn">Download .zip</a>
51+
<a href="" class="btn">Download .tar.gz</a>
52+
53+
</header>
54+
55+
<main id="content" class="main-content" role="main">
56+
<h1 id="smalltextpad-flatpak-build-instructions">SmallTextPad Flatpak Build Instructions</h1>
57+
58+
<p>This guide explains how to build SmallTextPad as a Flatpak package from source.</p>
59+
60+
<h2 id="prerequisites">Prerequisites</h2>
61+
62+
<h3 id="install-pre-requisite-flatpakrepo--flatpak-builder">Install pre-requisite flatpakrepo &amp; flatpak-builder</h3>
63+
64+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak remote-add <span class="nt">--if-not-exists</span> <span class="nt">--user</span> flathub https://dl.flathub.org/repo/flathub.flatpakrepo
65+
</code></pre></div></div>
66+
67+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak <span class="nb">install </span>org.flatpak.Builder
68+
</code></pre></div></div>
69+
70+
<h2 id="download-the-flatpak-manifest">Download the Flatpak Manifest</h2>
71+
72+
<h4 id="download-the-iogithubgcclinuxsmalltextpadyml">Download the io.github.gcclinux.smalltextpad.yml</h4>
73+
74+
<p><a href="https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml">https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml</a></p>
75+
76+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-O</span> https://raw.githubusercontent.com/gcclinux/smalltextpad/refs/heads/main/io.github.gcclinux.smalltextpad.yml
77+
</code></pre></div></div>
78+
79+
<h2 id="build-process">Build Process</h2>
80+
81+
<h3 id="build-the-flatpak">Build the Flatpak</h3>
82+
83+
<p>Use the flatpak-builder command to build the package:</p>
84+
85+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak-builder <span class="nt">--force-clean</span> <span class="nt">--user</span> <span class="nt">--install-deps-from</span><span class="o">=</span>flathub <span class="nt">--repo</span><span class="o">=</span>repo builddir io.github.gcclinux.smalltextpad.yml
86+
</code></pre></div></div>
87+
88+
<h3 id="export-the-flatpak-package">Export the Flatpak Package</h3>
89+
90+
<p>After the build is complete, export the package to a file:</p>
91+
92+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak build-export repo builddir
93+
</code></pre></div></div>
94+
95+
<h3 id="create-the-flatpak-file">Create the Flatpak File</h3>
96+
97+
<p>Use the flatpak build-bundle command to create the .flatpak file:</p>
98+
99+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak build-bundle repo SmallTextPad-1.5.1.flatpak io.github.gcclinux.smalltextpad
100+
</code></pre></div></div>
101+
102+
<h3 id="install-the-created-file">Install the Created File</h3>
103+
104+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak <span class="nb">install</span> <span class="nt">--user</span> SmallTextPad-<span class="si">$(</span><span class="nb">arch</span><span class="si">)</span><span class="nt">-1</span>.5.1.flatpak
105+
</code></pre></div></div>
106+
107+
<h2 id="running-smalltextpad">Running SmallTextPad</h2>
108+
109+
<p>After installation, you can run SmallTextPad from your application menu or via command line:</p>
110+
111+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>flatpak run io.github.gcclinux.smalltextpad
112+
</code></pre></div></div>
113+
114+
<h2 id="notes">Notes</h2>
115+
116+
<ul>
117+
<li>The Flatpak includes all necessary Java runtime dependencies</li>
118+
<li>SmallTextPad will have access to your home directory, documents, desktop, and downloads folders</li>
119+
<li>The application supports both X11 and Wayland display servers</li>
120+
<li>All encryption, multi-language support, and core features are included in the Flatpak build</li>
121+
</ul>
122+
123+
124+
<footer class="site-footer">
125+
126+
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
127+
</footer>
128+
</main>
129+
</body>
130+
</html>

‎docs/_site/feed.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.4.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2025-10-11T23:09:13+01:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">SmallTextPad</title><subtitle>A lightweight Java text editor with encryption and multi-language support</subtitle><author><name>Ricardo Wagemaker</name></author></feed>
1+
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="4.4.1">Jekyll</generator><link href="http://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2025-10-12T20:46:00+01:00</updated><id>http://localhost:4000/feed.xml</id><title type="html">SmallTextPad</title><subtitle>A lightweight Java text editor with encryption and multi-language support</subtitle><author><name>Ricardo Wagemaker</name></author></feed>

‎docs/_site/index.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,11 @@ <h3 id="-package-build-guides">📦 Package Build Guides</h3>
177177
<td>Linux Universal</td>
178178
<td><a href="README-snap.html">📄 Snap Build Guide</a></td>
179179
</tr>
180+
<tr>
181+
<td><strong>Flatpak</strong></td>
182+
<td>Linux Universal</td>
183+
<td><a href="README-flatpak.html">📄 Flatpak Build Guide</a></td>
184+
</tr>
180185
<tr>
181186
<td><strong>RPM</strong></td>
182187
<td>Fedora/RHEL/openSUSE</td>

‎docs/_site/sitemap.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
4+
<loc>http://localhost:4000/README-flatpak.html</loc>
5+
</url>
6+
<url>
47
<loc>http://localhost:4000/README-jar.html</loc>
58
</url>
69
<url>

‎docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Want to build SmallTextPad from source or create packages for distribution? Chec
6767
|--------|----------|---------------|
6868
| **JAR** | All Platforms | [📄 JAR Build Guide](README-jar.html) |
6969
| **Snap** | Linux Universal | [📄 Snap Build Guide](README-snap.html) |
70+
| **Flatpak** | Linux Universal | [📄 Flatpak Build Guide](README-flatpak.html) |
7071
| **RPM** | Fedora/RHEL/openSUSE | [📄 RPM Build Guide](README-rpm.html) |
7172
| **Windows** | Windows | [📄 Windows Build Guide](README-windows.html) |
7273

0 commit comments

Comments
 (0)