From 66bda5db395af4d4a34b61e05438364df5aca16b Mon Sep 17 00:00:00 2001 From: Danila Fedorin Date: Tue, 15 Aug 2017 00:40:28 -0700 Subject: [PATCH] Add the download page. --- docs/_pages/download.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/_pages/download.md diff --git a/docs/_pages/download.md b/docs/_pages/download.md new file mode 100644 index 0000000..b4cb688 --- /dev/null +++ b/docs/_pages/download.md @@ -0,0 +1,34 @@ +--- +in_header: true +layout: page +title: Download +permalink: /download/ +--- + +Currently, we do not provide standalone executables due to our unfamiliarity with +including 3rd-party software. Abacus uses a number of open source libraries, +and we do not want to breach the license terms for any of them. As soon as +as we figure out the correct way to distribute Abacus, we will make a +standalone distribution available. In the meantime, please use the below +steps to run Abacus from source. + +## Getting the Code +Abacus is an open source project, and is distributed under the MIT license. +If you would like to download the source code, simply clone it from +[GitHub](https://github.com/DanilaFe/abacus). +Alternatively, if you don't want the bleeding edge version, check out the +[releases](https://github.com/DanilaFe/abacus/releases). + +## Running from Source +Once you have unpacked the source code, you can simply run it from +the command line via the shell command: +``` +./gradlew run +``` +If you're on Windows, the command is similar: +``` +gradlew run +``` +This should download a distribution of Gradle, a build system that is +used to compile Abacus. After some time, the Abacus window should appear. +From there, you can use it normally.