Skip to content

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

Open
apetro wants to merge 2 commits into
Jasig:masterfrom
apetro:readme-building-and-running
Open

Add naive instructions to README.md for building and running.#5
apetro wants to merge 2 commits into
Jasig:masterfrom
apetro:readme-building-and-running

Conversation

@apetro

@apetro apetro commented Feb 2, 2017

Copy link
Copy Markdown
Member

These instructions result in an app at least launching.
Looks like there's more to be done to make the launched app interesting.

These instructions result in an app at least launching.
Looks like there's more to be done to make the launched app interesting.

@ChristianMurphy ChristianMurphy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, Thanks @apetro!

Comment thread README.md Outdated

Build using

```shell_session

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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. 😕 🤷‍♂️

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.
@apetro

apetro commented Feb 6, 2017

Copy link
Copy Markdown
Member Author

This instructions will no longer be correct when #2 merges. That's okay. #2 is progress. But will need to rev these instructions, or close PR and try again in light of the onejar approach of #2.

@BKKirchoff

BKKirchoff commented Feb 6, 2017 via email

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants