-
-
Notifications
You must be signed in to change notification settings - Fork 89
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
update ABOUT.md #153
update ABOUT.md #153
Conversation
It's a very good start. I think it would be better to focus on describing the language more than telling the users why they should use it. Looking at other description documents, they follow a similar pattern:
That seems like a good pattern for us as well. From the creator's website https://tiswww.case.edu/php/chet/bash/bashtop.html and https://tiswww.case.edu/php/chet/bash/FAQ:
From the GNU's page https://www.gnu.org/software/bash/:
Origin of name:
Wiki description (why not?):
|
I'll look to condense these into the description. Some snippets above seem almost excessive in detail, and we should look to keep this intro somewhat concise - I'll update my PR this evening hopefully with the changes 🙂 |
@kotp what do you think? |
Looking forward to what @sjwarner-bp comes up with. Should we mention how to get help on bash in the terminal? Such as I don't believe the mention of |
Any updates on this? |
Been a bit ill recently - I'll get back on this as soon as! Wanted to make sure that it is done well 😉 |
I've added in a handful of the suggestions above. Let me know if you think I've missed any of the important bits (some of the paragraphs mentioned above had quite a bit of overlap). |
docs/ABOUT.md
Outdated
@@ -1,14 +1,14 @@ | |||
Bash is the language that you will learn to love! Many of your everyday computer tasks can be done using the concise scripts it can produce. You will soon learn that while most things can be done through a Graphical User Interface, it can actually be vastly faster to use this powerful language! | |||
Bash is the language that you will learn to love! Many of your everyday computer tasks can be done using the concise scripts it can produce. You will soon learn that while most things can be done through a Graphical User Interface, it can actually be vastly faster to use this powerful language! The command processor typically runs in a text window, where users may input commands (operations may also come from some files, also known as Bash scripts). |
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.
Let's have one sentence per line, as agreed to on exercism/meta/#84
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.
There is no other mention of a "command processor", but "command interpreter" is the term used in the citation, and further used in the rest of the content.
@@ -1,5 +1,24 @@ | |||
Although most users think of the shell as an interactive command interpreter, it is really a programming language in which each statement runs a command. Because it must satisfy both the interactive and programming aspects of command execution, it is a strange language, shaped as much by history as by design. —- Brian Kernighan & Rob Pike | |||
Bash is the language that you will learn to love! |
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.
Needs two spaces for new line.
docs/ABOUT.md
Outdated
> Although most users think of the shell as an interactive command interpreter, it is really a programming language in which each statement runs a command. | ||
> Because it must satisfy both the interactive and programming aspects of command execution, it is a strange language, shaped as much by history as by design. —- Brian Kernighan & Rob Pike | ||
|
||
_cite: Kernighan, Brian W.; Pike, Rob (1984). The UNIX Programming Environment. Englewood Cliffs: Prentice-Hall. ISBN 0-13-937699-2. |
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.
Is _cite valid markdown syntax?
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.
Oops! Forgot the closing _
- I wanted it to be italicised.
I'll fix these tonight 🙂
Looks good, thank you. |
Fixes #152
I'm open to suggestions for this, as I wasn't too sure what to write. Let me know if you think I've missed out any important points @exercism/bash