Issues πΈ Documentation πΈ Releases
β Project Overview
The Bash-Bits ANSI Module - colour and style codes for ANSI terminals. This module contains not only all of the colour and style definitions to help make Bash-Bits attractive and fun to work with, it provides some of the more common "quality of life" enhancements to make every day with Bash-Bits that much easier.
The Branch Reliability Table is a way for you to determine how close to the bleeding edge you're comfortable getting.
If you need stability, then download a branch marked with π’
If you're contributing code to the project, you'll want π΄
Branch | Stability | Code Age | Reliability |
---|---|---|---|
master |
latest stable | latest release | π’ |
develop |
latest unstable | most recent code | π΄ |
β What's Included?
- β bb-ansi.sh
π Installation
Like ALL other Bash-Bits Modules, BB-ANSI
is "imported" using the BB-Import Module. If you haven't yet installed BB-Import
, perhaps you'd like to do so now? It's as easy as running the following command in your terminal:
bash <(curl -sfLS https://raw.githubusercontent.com/bash-bits/bb-import/master/install.sh)
Once you've installed BB-Import
, you can include BB-ANSI
in ANY of your Bash projects by including the following code snippet at the top of each file:
#!/usr/bin/env bb-import
bb-import bb-ansi
π Badges
πͺ Available Support
β€οΈ Project Supporters
π§ Author / Maintainer
π Security
While the Bash-Bits
project follows good security practices, 100% security can never be guaranteed in any software package. The Bash-Bits ANSI Module
is provided AS IS, and without warranty. You can find more details in the LICENSE file included with this repository.
If you discover any issue regarding the security of this project, please disclose that information responsibly by sending a security advisory. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE
π Contributors
If you'd like to make a contribution, then please see the Bash-Bits Contributor's Guide
It's not just contributions of code that I'm looking for. If you have any ideas or suggestions about how this project may be improved, don't hesitate to open an issue and let me know! Contributions of ALL kinds will be recognised here if they are made part of this project - thanks to the All-Contributors bot.
Β©οΈ Copyright & Attributions
This project incorporates ideas and / or code crafted by the following talented individuals:
-
importpw/import
Copyright Β© 2018-2020 the Import authors
MIT Licensed -
niieani/bash-oo-framework
Copyright Β© 2015 Bazyli BrzΓ³ska @ https://invent.life/
MIT Licensed -
fidian/ansi
Copyright Β© 2015 Tyler Akins
MIT Licensed
"We see much further, and reach much higher,
only because we stand upon the shoulders of giants"
βοΈ License
Copyright Β© 2022-2023 Darren (Ragdata) Poulton
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.