Build Kink

The build is set up to run on Ubuntu 16.04, but other Unix-like systems could also be used as a build environment.

The following tools are required to build Kink artifacts:

• JDK 17
  • on $JAVA_HOME environment variable
• GNU bash
  • bash apt package
  • required to build the manual
• GNU make
  • make apt package
  • required to build the manual
• graphviz
  • graphviz apt package
  • required to build the manual
• gettext
  • gettext apt package
  • required to build the manual
• Sphinx
  • python-sphinx apt package
  • required to build the manual
  • command can be configured as sphinx_build_command property in gradle.properties
• MinGW GCC
  • gcc-mingw-w64 apt package
  • required to build Windows exe files
  • command can be configured as mingw_gcc_command property in gradle.properties
• Mercurial
  • mercurial apt package
  • to build a zip/tarball archive, the source tree must be cloned by Mercurial
  • to clone the source tree, run hg clone https://hg.osdn.net/view/kink/kink

The following is a list of important Gradle tasks:

• ./gradlew libDir
  • builds lib/*.jar
  • you can use bin/kink command after the task
• ./gradlew exeFile
  • builds bin/kink.exe and bin/kinkw.exe
• ./gradlew manual
  • builds the manual under doc/manual* directories
• ./gradlew javadoc
  • builds Javadoc under doc/javadoc
• ./gradlew zip tarball
  • builds ./kink-{version}.zip and ./kink-{version}.tar.gz, which are distribution packages
  • to run this task, the source tree must be cloned by hg clone https://hg.osdn.net/view/kink/kink
• ./gradlew test
  • runs JUnit tests
  • this task is also available on Windows
• ./gradlew clean
  • removes generated files

Run Kink

The following tools are required to build Kink artifacts:

• JDK 17
• GNU bash; only on Unix-like systems

First extract kink-{version} directory from the zip archive or tarball archive.

Then launch REPL by running kink-{version}/bin/kink. If you want line editing, get rlwrap and run rlwrap kink-{version}/bin/kink.

You can get help by running kink-{version}/bin/kink --help.

On Windows, you have two exe files: kink.exe and kinkw.exe. The first one launches java.exe, so it suits for CUI applications. The latter launches javaw.exe, so its suits for GUI applications.

Licenses

Kink is developed by Miyakawa Taku and distributed under the MIT license. See LICENSE.txt.

Kink distributions may include thirdparty softwares. See doc/license.html or src/docroot/license.rst for the licenses of the thirdparty softwares.

Links

• Project Hosting
• Documentation
• Continuous Integration

Author

Name

Miyakawa Taku

Mail

miyakawa.taku@gmail.com

Twitter

@miyakawa_taku