From db95b4835c1d1427830dc1dd978f1ab4614ac743 Mon Sep 17 00:00:00 2001 From: dgelessus <dgelessus@users.noreply.github.com> Date: Wed, 29 Aug 2018 16:41:13 +0200 Subject: [PATCH] Release version 1.0.0 GitLab (or at least this installation) doesn't have a way of uploading release binaries like GitHub does, so I'm committing the release jar into the repo (using Git LFS). --- .gitattributes | 1 + README.md | 9 ++++----- build.gradle | 2 ++ releases/prob2-jupyter-kernel-1.0.0-all.jar | 3 +++ 4 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 .gitattributes create mode 100644 releases/prob2-jupyter-kernel-1.0.0-all.jar diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d0b3d53 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +releases/*.jar filter=lfs diff=lfs merge=lfs -text diff --git a/README.md b/README.md index e4e86bf..a7bcb47 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,12 @@ This is a [Jupyter](https://jupyter.org/) kernel for the [ProB animator and mode ### For end users -**Note:** Prebuilt jar files are not available yet, so this installation method currently requires downloading the source code and building the jar manually. This is done using `./gradlew shadowJar`, and the built jar is placed at `build/libs/prob2-jupyter-kernel-all.jar`. Once you have built the jar: - -1. If Jupyter is installed in a virtual environment, activate it. -2. Run `java -jar <jarfile> install` to install the kernel. +1. Download the latest version of the kernel [here](https://gitlab.cs.uni-duesseldorf.de/dgelessus/prob2-jupyter-kernel/blob/master/releases/prob2-jupyter-kernel-1.0.0-all.jar). +2. If Jupyter is installed in a virtual environment, activate it. +3. Run `java -jar <jarfile> install` to install the kernel. (`<jarfile>` is the name of the jar file that you just downloaded.) * This assumes that Jupyter can be called using the command `jupyter`. To use a different command in place of `jupyter`, pass it as an argument after `install`, e. g. `java -jar <jarfile> install /path/to/jupyter`. * To use a different ProB home directory than the default, pass `-Dprob.home=/path/to/prob/home` before the `-jar` option. (The path must be absolute.) -3. (Optional) The jar file can be deleted after installation. +4. (Optional) The jar file can be deleted after installation. To update the kernel, follow the same instructions with the new jar file. diff --git a/build.gradle b/build.gradle index 90cfa3a..59aab10 100644 --- a/build.gradle +++ b/build.gradle @@ -9,6 +9,8 @@ plugins { id("com.github.johnrengelman.shadow").version("2.0.4") } +version = "1.0.0" + final SOURCE_ENCODING = "UTF-8" wrapper { diff --git a/releases/prob2-jupyter-kernel-1.0.0-all.jar b/releases/prob2-jupyter-kernel-1.0.0-all.jar new file mode 100644 index 0000000..09ce5cd --- /dev/null +++ b/releases/prob2-jupyter-kernel-1.0.0-all.jar @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c59c4d4ae7a824074af9b5c957182ada5e2594d5bead940efe561c85278b6039 +size 93136864 -- GitLab