Skip to content

Commit

Permalink
Add installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
philipborg committed Mar 27, 2022
1 parent f41ea22 commit fe08c35
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ image:https://img.shields.io/github/followers/philipborg?style=social[GitHub fol
CubeShuffle aims to improve your card game cube shuffling by offering more control over the card distribution/randomness and/or increasing shuffling speed by combining digital and manual shuffling.
It is designed to be generic for all card games with a cube format but I, the developer, primarily play Magic The Gathering (unaffiliated).

== Installation

There are currently three different ways to install CubeShuffle.
Be aware that there are currently no automatic updates operational on any platform.

.Platforms
* link:docs/installation/Desktop.adoc[Desktop GUI] (Recommended)
* link:docs/installation/Android.adoc[Android]
* link:docs/installation/CLI.adoc[Command Line Interface]

== [#Distribution shuffle]#link:docs/distribution_shuffle.adoc[Distribution shuffle]#

A quick and easy shuffling method for cubes where cards can be assigned to and distributed based upon groups.
Expand Down
12 changes: 12 additions & 0 deletions docs/installation/Android.adoc
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.
26 changes: 26 additions & 0 deletions docs/installation/CLI.adoc
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.
15 changes: 15 additions & 0 deletions docs/installation/Desktop.adoc
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.

0 comments on commit fe08c35

Please sign in to comment.