Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add naive instructions to README.md for building and running. #5

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add naive instructions to README.md for building and running. #5

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feb951b
Add naive instructions to README.md for building and running.
apetro Feb 2, 2017
693f338
Highlight as `ShellSession` not `shell_session`
apetro Feb 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# ImageQuiz

See [the documentation website](http://jasig.github.io/ImageQuiz).

## Building

Build using

```shell_session
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Github doesn't recognize recognize shell_session as a language, these are the aliases that will trigger code highlights. https://github.com/github/linguist/blob/master/lib/linguist/languages.yml#L3953-L3957

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah. I was relying upon the Rouge lexers supported by GitHub Pages, hadn't realized it's a different set for GitHub itself.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, I'm surprised linguist doesn't support all the same aliases as Rouge, since the two are supposed to be interchangeable. 😕 🤷‍♂️

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.