Welcome To The Onyx Bash Project
Are you looking for a great starter open source Project? Then this is a great place for you! The Onyx Bash Project is written in two simple programming languages (Python & Shell-Script) and have a very simple code design. We’re also trying to make it as easy as possible for beginners/intermediates to submit code and Pull Requests.God Luck!
Installing Onyx Bash is very simple.
- Download the folder ‘TheOnyxBashProject’. The easiest and recommended way to download the project (for none contributors) is to just click This Link Or click the download buttons at the top of the page and locate the ‘TheOnyxBashProject’ Folder.
- Extract zip file
- Open a Terminal inside the folder and type :
- And then
And you are done!
Just remove the folder you downloaded earlier.
If you want to submit code (which is always very welcome and appreciated), please follow these guidelines listed below:
- Always write well commented code.
- Split your code into Parts. ex. Part 0 : Setup, Part 1 : Filename, Part…
- Use the GNU GPL v. 3 (more info on how to use it on gnu.org ).
- Respect the GNU GPL.
- Write your programs in Shell-Script or Python.
- The programs should be designed to run on Linux and should not be created for Mac OSX (this is a feature that could be added later).
- When doing a Pull Request please write a detailed explanation/report on your code.
- Use this at the top of your file(s) as comments. Exactly as shown below. Change everything between stars:
# The Onyx Bash Project **Name Of Program** # A Program that **Description of your program** # Version **1.0** # # **Your Name**, Gevosoft, hereby disclaims all copyright interest in the program “The Onyx Bash Project **Program Name**” (**Porgram Description**) written by **Your Name**. # signature of **Your Name** *13 November 2017* # **Your Name & Work Title** # Copyright **2018** **Your Name** # This file is part of The Onyx Bash Project. # The Onyx Bash Project is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # The Onyx Bash Project is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # You should have received a copy of the GNU General Public License # along with The Onyx Bash Project. If not, see <http://www.gnu.org/licenses/>. # Contact and FAQ : http://onyxbash.ml OR See the README.
A word of advice: If you do not comment your code then it will be ignored. And I have zero tolerance when it comes to misuse of the GNU GPL so if you misuse or try to misuese The GNU GPL your Pull Request will immediately be deleted and ignored!
Kelly Programming Language Terminal
The Onyx Bash Project includes a simple BASIC-Inspired Programming Language terminal. This is a list of available commands:
- Printing text to the screen: print (“your text”)
- Creating a variable: var (var_name = “some string”)
- Printing variables: print (var_name)
- Combining a variable and a string: var ($some_var + “some string”)
- Clear the screen: clear
- Exit Kelly: exit
- Help menu & Command list: help
- Credits: credits
Gevosoft The Onyx Bash Project 2019