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.

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

Conversation

apetro
Copy link
Member

@apetro apetro commented Feb 2, 2017

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.
Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

LGTM, Thanks @apetro!

README.md Outdated

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

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
Copy link
Member Author

apetro commented Feb 6, 2017

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
Copy link

BKKirchoff commented Feb 6, 2017 via email

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