-
Notifications
You must be signed in to change notification settings - Fork 4
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
base: master
Are you sure you want to change the base?
Conversation
These instructions result in an app at least launching. Looks like there's more to be done to make the launched app interesting.
There was a problem hiding this 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Hi Andrew,
I am going to need you to translate these messages into non technical language for me until I learn the lingo. I am lost right now.
Best wishes,
Bruce
-----------
Bruce Kirchoff
"Education is that which remains, if one has forgotten everything he learned in school."
- Einstein
…On Feb 6, 2017, 10:27 AM -0500, Andrew Petro ***@***.***>, wrote:
This instructions will no longer be correct when #2 (#2) merges. That's okay. #2 (#2) is progress. But will need to rev these instructions, or close PR and try again in light of the onejar approach of #2 (#2).
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub (#5 (comment)), or mute the thread (https://github.com/notifications/unsubscribe-auth/ARqa-a-x9lgoz4j6JuM_0q7zQxx6dD9Mks5rZzvQgaJpZM4L0uQB).
|
These instructions result in an app at least launching.
Looks like there's more to be done to make the launched app interesting.