jrpie/launcher-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

initial commit

Browse source
This commit is contained in:
Josia Pietsch 2025-05-24 15:04:39 +02:00
commit cbcb340697
Signed by: jrpie
GPG key ID: E70B571D66986A2D
199 changed files with 9449 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

411
public/docs/build/index.html vendored Normal file
View file

@ -0,0 +1,411 @@
<!DOCTYPE html>
<html lang="en-dk" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="
Building from Source
#
Using the command line
#
Install JDK 17 and the Android SDK.
Make sure that JAVA_HOME and ANDROID_HOME are set correctly.
git clone https://github.com/jrpie/Launcher
cd Launcher
./gradlew assembleDefaultRelease
This will create an apk file at app/build/outputs/apk/default/release/app-default-release-unsigned.apk.
Note that you need to sign it:
apksigner sign --ks &#34;$YOUR_KEYSTORE&#34; \
--ks-key-alias &#34;$YOUR_ALIAS&#34; \
--ks-pass=&#34;pass:$YOUR_PASSWORD&#34; \
--key-pass=&#34;pass:$YOUR_PASSWORD&#34; \
--alignment-preserved \
--v1-signing-enabled=true \
--v2-signing-enabled=true \
--v3-signing-enabled=true \
--v4-signing-enabled=true \
app-default-release-unsigned.apk
See this guide
for further instructions.">
<meta name="theme-color" media="(prefers-color-scheme: light)" content="#ffffff">
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="#343a40">
<meta name="color-scheme" content="light dark"><meta property="og:url" content="https://example.org/docs/build/">
<meta property="og:site_name" content="μLauncher">
<meta property="og:title" content="μLauncher">
<meta property="og:description" content="Building from Source # Using the command line # Install JDK 17 and the Android SDK. Make sure that JAVA_HOME and ANDROID_HOME are set correctly.
git clone https://github.com/jrpie/Launcher cd Launcher ./gradlew assembleDefaultRelease This will create an apk file at app/build/outputs/apk/default/release/app-default-release-unsigned.apk.
Note that you need to sign it:
apksigner sign --ks &#34;$YOUR_KEYSTORE&#34; \ --ks-key-alias &#34;$YOUR_ALIAS&#34; \ --ks-pass=&#34;pass:$YOUR_PASSWORD&#34; \ --key-pass=&#34;pass:$YOUR_PASSWORD&#34; \ --alignment-preserved \ --v1-signing-enabled=true \ --v2-signing-enabled=true \ --v3-signing-enabled=true \ --v4-signing-enabled=true \ app-default-release-unsigned.apk See this guide for further instructions.">
<meta property="og:locale" content="en_dk">
<meta property="og:type" content="article">
<meta property="article:section" content="docs">
<title>Build | μLauncher</title>
<link rel="icon" href="/favicon.png" >
<link rel="manifest" href="/manifest.json">
<link rel="canonical" href="https://example.org/docs/build/">
<link rel="stylesheet" href="/book.min.e169ae81276ac2a9574d04077e296591738aa6929473ad4174d9d0f1e58d78f0.css" integrity="sha256-4WmugSdqwqlXTQQHfillkXOKppKUc61BdNnQ8eWNePA=" crossorigin="anonymous">
<script defer src="/fuse.min.js"></script>
<script defer src="/en.search.min.42aa96a65b086b8370bdaae4169ed3fc9b3d4281439fa86054dedf6156aa1807.js" integrity="sha256-QqqWplsIa4NwvarkFp7T/Js9QoFDn6hgVN7fYVaqGAc=" crossorigin="anonymous"></script>
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
-->
</head>
<body dir="ltr">
<input type="checkbox" class="hidden toggle" id="menu-control" />
<input type="checkbox" class="hidden toggle" id="toc-control" />
<main class="container flex">
<aside class="book-menu">
<div class="book-menu-content">
<nav>
<h2 class="book-brand">
<a class="flex align-center" href="/"><img src="/images/logo.png" alt="Logo" class="book-icon" /><span>μLauncher</span>
</a>
</h2>
<div class="book-search hidden">
<input type="text" id="book-search-input" placeholder="Search" aria-label="Search" maxlength="64" data-hotkeys="s/" />
<div class="book-search-spinner hidden"></div>
<ul id="book-search-results"></ul>
</div>
<script>document.querySelector(".book-search").classList.remove("hidden")</script>
<ul>
<li>
<a href="/chat/" class="">Chat</a>
</li>
<li>
<a href="/donate/" class="">Donate</a>
</li>
<li>
<span>Docs</span>
<ul>
<li>
<a href="/docs/actions-and-gestures/" class="">Actions and Gestures</a>
</li>
<li>
<a href="/docs/build/" class="active">Build</a>
</li>
<li>
<a href="/docs/changes-fork/" class="">Changes Fork</a>
</li>
<li>
<a href="/docs/contributing/" class="">Contributing</a>
</li>
<li>
<a href="/docs/home/" class="">Home</a>
</li>
<li>
<a href="/docs/profiles/" class="">Profiles</a>
</li>
<li>
<a href="/docs/settings/" class="">Settings</a>
</li>
</ul>
</li>
</ul>
</nav>
<script>(function(){var e=document.querySelector("aside .book-menu-content");addEventListener("beforeunload",function(){localStorage.setItem("menu.scrollTop",e.scrollTop)}),e.scrollTop=localStorage.getItem("menu.scrollTop")})()</script>
</div>
</aside>
<div class="book-page">
<header class="book-header">
<div class="flex align-center justify-between">
<label for="menu-control">
<img src="/svg/menu.svg" class="book-icon" alt="Menu" />
</label>
<h3>Build</h3>
<label for="toc-control">
<img src="/svg/toc.svg" class="book-icon" alt="Table of Contents" />
</label>
</div>
<aside class="hidden clearfix">
<nav id="TableOfContents">
<ul>
<li><a href="#using-the-command-line">Using the command line</a></li>
<li><a href="#using-android-studio">Using Android Studio</a></li>
<li><a href="#ci-pipeline">CI Pipeline</a></li>
</ul>
</nav>
</aside>
</header>
<article class="markdown book-article"><h1 id="building-from-source">
Building from Source
<a class="anchor" href="#building-from-source">#</a>
</h1>
<h2 id="using-the-command-line">
Using the command line
<a class="anchor" href="#using-the-command-line">#</a>
</h2>
<p>Install JDK 17 and the Android SDK.
Make sure that <code>JAVA_HOME</code> and <code>ANDROID_HOME</code> are set correctly.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git clone https://github.com/jrpie/Launcher
</span></span><span style="display:flex;"><span>cd Launcher
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>./gradlew assembleDefaultRelease
</span></span></code></pre></div><p>This will create an apk file at <code>app/build/outputs/apk/default/release/app-default-release-unsigned.apk</code>.</p>
<p>Note that you need to sign it:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>apksigner sign --ks <span style="color:#e6db74">&#34;</span>$YOUR_KEYSTORE<span style="color:#e6db74">&#34;</span> <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --ks-key-alias <span style="color:#e6db74">&#34;</span>$YOUR_ALIAS<span style="color:#e6db74">&#34;</span> <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --ks-pass<span style="color:#f92672">=</span><span style="color:#e6db74">&#34;pass:</span>$YOUR_PASSWORD<span style="color:#e6db74">&#34;</span> <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --key-pass<span style="color:#f92672">=</span><span style="color:#e6db74">&#34;pass:</span>$YOUR_PASSWORD<span style="color:#e6db74">&#34;</span> <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --alignment-preserved <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --v1-signing-enabled<span style="color:#f92672">=</span>true <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --v2-signing-enabled<span style="color:#f92672">=</span>true <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --v3-signing-enabled<span style="color:#f92672">=</span>true <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> --v4-signing-enabled<span style="color:#f92672">=</span>true <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> app-default-release-unsigned.apk
</span></span></code></pre></div><p>See <a href="https://developer.android.com/build/building-cmdline">this guide</a>
for further instructions.</p>
<h2 id="using-android-studio">
Using Android Studio
<a class="anchor" href="#using-android-studio">#</a>
</h2>
<p>Install <a href="https://developer.android.com/studio">Android Studio</a>, import this project and build it.</p>
<p>See <a href="https://developer.android.com/studio/run">this guide</a>
for further instructions. How to</p>
<h2 id="ci-pipeline">
CI Pipeline
<a class="anchor" href="#ci-pipeline">#</a>
</h2>
<p>The <a href="https://github.com/jrpie/Launcher/actions">CI pipeline</a> automatically creates debug builds.</p>
<blockquote>
<p>Note: These builds are <em>not</em> signed. They are in built in debug mode and only suitable for testing.</p></blockquote>
</article>
<footer class="book-footer">
<div class="flex flex-wrap justify-between">
</div>
<script>(function(){function e(e){const t=window.getSelection(),n=document.createRange();n.selectNodeContents(e),t.removeAllRanges(),t.addRange(n)}document.querySelectorAll("pre code").forEach(t=>{t.addEventListener("click",function(){if(window.getSelection().toString())return;e(t.parentElement),navigator.clipboard&&navigator.clipboard.writeText(t.parentElement.textContent)})})})()</script>
<div style="text-align: right"><a href="https://s.jrpie.de/android-legal">Legal Notice</a></div>
</footer>
<div class="book-comments">
</div>
<label for="menu-control" class="hidden book-menu-overlay"></label>
</div>
<aside class="book-toc">
<div class="book-toc-content">
<nav id="TableOfContents">
<ul>
<li><a href="#using-the-command-line">Using the command line</a></li>
<li><a href="#using-android-studio">Using Android Studio</a></li>
<li><a href="#ci-pipeline">CI Pipeline</a></li>
</ul>
</nav>
</div>
</aside>
</main>
</body>
</html>