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

Purpose readme contribution #10

Open
wants to merge 4 commits into
base: gh-pages
Choose a base branch
from
Open
Changes from all commits
Commits
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
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
bash.academy
============

The http://bash.academy website
The http://bash.academy website

What to use Bash Academy for
====================================

Bash Academy can be used in the following instances :

1. As a self teaching learning resource for anyone needing to learn how to use the bash shell. This includes beginners or people who are not familiar with the bash shell.

2. As a reference for bash users to look up syntax and uses for specific commands.

3. As a teaching aid for anyone teaching people how to use bash.

When to use bash academy and how to use it
================================================

Bash Academy can be downloaded onto a local storage medium and can be accessed via a web browser. Alternatively, one can host it on a web server and make it available to other users eg. students.

Bash Academy can be used whilst using the bash shell to look up commands via the easy to navigate interface. For teaching or learning purposes one can work through the respective sections in the order they have been presented or jump to a specific section which one wants to learn. The section on bash games(which is still to be completed) will also be a valuable and effective tool for revising concepts and testing one's skills.

The platform that bash academy is built upon also allows content to be easily edited and extended so teachers can update content if they need to do so. If one is using it as a reference, extra notes, caveats and snippets can be added for easy access later on when the need might arise.