-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f41ea22
commit fe08c35
Showing
4 changed files
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
= Android installation | ||
|
||
The distribution of the Android build is currently unfinished. | ||
Publishing to the Google Play Store is link:https://github.com/philipborg/CubeShuffle/issues/67[on the roadmap]. | ||
Only manual link:#_installing_aab[AAB installation] is currently available. | ||
|
||
[#_installing_aab] | ||
== Installing AAB | ||
The link:https://developer.android.com/guide/app-bundle[Android Application Bundle] is available from compiled link:https://github.com/philipborg/CubeShuffle/releases[releases]. | ||
To install use the link:https://developer.android.com/studio/command-line/bundletool[bundletool] to first generate an `apks` file which then can be installed, also using `bundletool`. | ||
Installing from `AAB` is moderately advanced and `CubeShuffle` will not handle issues during generation of `apks` files nor their installation, though pull requests expanding this guide are welcome. | ||
After a successful installation all issues are treated like other installation methods. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
= Command Line Interface (CLI) installation | ||
|
||
.Installation sources | ||
* link:#_github_releases[Github Releases] | ||
* link:#_from_source[From source] | ||
[#_github_releases] | ||
== Github Releases | ||
Simply download one of the readily compiled executables from link:https://github.com/philipborg/CubeShuffle/releases[Releases]. | ||
Make sure you choose the correct one for your platform. | ||
[#_from_source] | ||
== From source | ||
.Steps | ||
. link:https://rustup.rs/[Install rustup] if not already installed. Recommendation is to not use a Linux package manager for this as it may not set the default paths. | ||
. Run the following link:https://doc.rust-lang.org/cargo/commands/cargo-install.html[cargo install] terminal command to install the latest `master` version: | ||
+ | ||
[source,sh] | ||
---- | ||
cargo install --locked --git https://github.com/philipborg/CubeShuffle.git cube_shuffle-cli | ||
---- | ||
For a specific link:https://github.com/philipborg/CubeShuffle/tags[tagged version] you may add the `--tag {TAG ID}` parameter after `install`. | ||
Without the `--tag` parameter the latest `master` branch version will be used which may not be released yet. | ||
. Run the program using `cube_shuffle-cli` from a terminal. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
= Graphical desktop installation | ||
|
||
.Steps | ||
. Browse to link:https://github.com/philipborg/CubeShuffle/releases[the releases]. | ||
. Download the correct compiled version. | ||
+ | ||
* Linux | ||
** link:https://appimage.org[AppImage] (#recommended#) - Download, extract and run `CubeShuffle-GUI.AppImage.tar.gz`. Optionally choose `Integrate and run` during startup to install persistently. | ||
** Debian installation file (`deb`) - Download and install `CubeShuffle-GUI.deb`. | ||
* MacOS | ||
** Disk Image (`dmg`) (#recommended#) - Download and install `CubeShuffle-GUI.dmg`. | ||
** Executable (`app`) - Download and extract `CubeShuffle-GUI.app.tar.gz`. | ||
* Windows | ||
** Windows Installer (#recommended#) - Download and run `CubeShuffle-GUI.msi.zip`. | ||
Follow the installation steps. |