Skip to content

Latest commit

 

History

History
114 lines (68 loc) · 2.68 KB

BUILD.md

File metadata and controls

114 lines (68 loc) · 2.68 KB
Raw

Introduction

This document describes how to build the application and platform binaries.

Requirements

Download and install the following software packages:

Note: The forked warp packer release fixes a bug in the main branch.

Repository

Clone the repository as follows:

git clone https://github.com/DaveJarvis/keenwrite.git

The repository is cloned.

Build

Build the application überjar as follows:

cd keenwrite
gradle clean jar

The application is built.

Run

After the application is compiled, run it using keenwrite.sh.

Integrated development environments

This section describes setup instructions to import and run the application using an integrated development environment (IDE). Running the application should trigger a build.

IntelliJ IDEA

This section describes how to build and run the application using IntellIJ's IDEA.

Import

Complete the following steps to import the application:

  1. Start the IDE.
  2. Click File → New → Project from Existing Sources.
  3. Browse to the directory containing keenwrite.
  4. Click OK.
  5. Select Gradle as the external model.
  6. Click Finish.

The project is imported into the IDE.

Run

Run the application within the IDE as follows:

  1. Open Launcher.java.
  2. Click Run → Launcher.

The application is started.

Installers

This section describes how to set up the development environment and build native executables for supported operating systems.

Setup

Follow these one-time setup instructions to begin:

  1. Ensure $HOME/bin is set in the PATH environment variable.
  2. Copy build-template into $HOME/bin.

Setup is complete.

Binaries

Run the installer script to build platform-specific binaries, such as:

./installer -V -o linux

The installer script:

  • downloads a JDK;
  • generates a run script;
  • bundles the JDK, run script, and JAR file; and
  • creates a standalone binary, so no installation required.

Run ./installer -h to see all command-line options.

Releases

After installing scripts/build-template, build release binaries as follows:

git tag -a 2.0.0 -m "Release name"
git push origin --tags
./release.sh

When finished, browse to the project releases page to draft a new release.

Versioning

Version numbers are read directly from Git using a plugin. The version number is written to app.properties in the resources directory. The application reads that file to display version information upon start.