From feb951b7c5f8c97bcdd062a927a76032932ab49d Mon Sep 17 00:00:00 2001 From: Andrew Petro Date: Wed, 1 Feb 2017 22:55:03 -0600 Subject: [PATCH 1/2] Add naive instructions to README.md for building and running. These instructions result in an app at least launching. Looks like there's more to be done to make the launched app interesting. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b8da9c4..97f550a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # ImageQuiz See [the documentation website](http://jasig.github.io/ImageQuiz). + +## Building + +Build using + +```shell_session +mvn package +``` + +This will result in an executable + +`target/ImageQuiz-1.0-SNAPSHOT/ImageQuiz.app` + +## Running + +On at least MacOS, the `ImageQuiz.app` built above is executable such that you can double-click it in the Finder and ImageQuiz will launch. From 693f338f817987f9533cc554cf59719ad5e72b28 Mon Sep 17 00:00:00 2001 From: Andrew Petro Date: Thu, 2 Feb 2017 09:17:46 -0600 Subject: [PATCH 2/2] Highlight as `ShellSession` not `shell_session` Use the GitHub-supported `linguist` [name for shell sessions](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml#L3986) rather than the GitHub-Pages-supported `Rouge` name for shell sessions in marking shell example for code highlighting. In practice currently a no-op, since neither `shell_session` nor `ShellSession` (nor `shell`) yield interesting highlighting for this specific code block. Nonetheless, the code highlighting language type declaration probably adds a tiny bit of value in clarifying what the example in the code block is. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 97f550a..57acb45 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ See [the documentation website](http://jasig.github.io/ImageQuiz). Build using -```shell_session +```ShellSession mvn package ```