Skip to content

A collection of scripts designed to enhance the visual appeal of your upcoming Bash script project.

License

Notifications You must be signed in to change notification settings

iamprogrammerlk/library_pretty_bash





Library Pretty Bash

A collection of scripts designed to enhance the visual appeal of your upcoming Bash script project.

Tip

⭐ Star This Repository

If you enjoy this project and my work, please consider supporting me giving a ⭐ star ⭐ to this repository.

πŸͺ§ Usage

Option 01 (Recommended)

  • Use the official template repository and start building

    git clone --recurse-submodules https://github.com/iamprogrammerlk/template_bash_script.git
    

Important

Don't forget the --recurse-submodules option,

If you already cloned the project and forgot --recurse-submodules, You must run following two commands from the main project git submodule init to initialize your local configuration file, and git submodule update to fetch all the files from the template_bash_script project, you can use the foolproof git submodule update --init --recursive command to also initialize, fetch and checkout any nested submodules.

  • Run the following command time to time in your project to keep up to date with the latest version of the Pretty Bash Library.

    git submodule update --remote
    

Option 02

  • Adding the library to an existing git project as a submodule.

    git submodule add https://github.com/iamprogrammerlk/library_pretty_bash.git library_pretty_bash
    

    This command clones the library_pretty_bash repository into the specified path and records it in the .gitmodules file and the parent's index.

  • Run the following command time to time in your project to keep up to date with the latest version of the Pretty Bash Library.

    git submodule update --remote
    


(πŸ‘† back to top πŸ‘†)


πŸͺ Examples

Open the library_pretty_bash/source/playground.sh file to play around.

  • Make the 'playground.sh' script executable

    sudo chmod +x library_pretty_bash/source/playground.sh
    
  • Then run

    ./library_pretty_bash/source/playground.sh
    


(πŸ‘† back to top πŸ‘†)


πŸ’• Credits


(πŸ‘† back to top πŸ‘†)


✨ Get Involved

Contributors are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Make your changes with clear commit messages (git commit -m "Add some AmazingFeature")
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Submit a pull request with description of changes

Read more about,

Get in touch with the project developers and the community through our Reddit.com Community forum.


(πŸ‘† back to top πŸ‘†)


πŸ”₯ Issues

Bug reports and feature requests can be submitted on the Github Issues. Please read the support.md and governance.md for more details.

Important

Please do not report security vulnerabilities through public Community Forum, GitHub Issues, Discussions, or Pull Requests. Instead, use SECURITY ADVISORIES


(πŸ‘† back to top πŸ‘†)


πŸ‘ Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct, Governance, Security Policy, and be bound by the terms of the Contributor License Agreement.

Important

This project is not a platform for discussing politics, social issues, race, religion, gender, or sexual orientation. Please keep those discussions elsewhere.


(πŸ‘† back to top πŸ‘†)


βš–οΈ License

This work is distributed under the Do What The F*ck You Want To Public License (WTFPL) 2.0 License.

See license for more information.

Permissions

  • βœ… Commercial use
  • βœ… Distribution
  • βœ… Modification
  • β›” Patent use
  • βœ… Private use

Conditions

  • β›” Disclose source
  • β›” License and copyright notice
  • β›” Network use is distribution
  • β›” Same license
  • β›” State changes

Limitations

  • 🚫 Liability
  • β›” Trademark use
  • 🚫 Warranty


(πŸ‘† back to top πŸ‘†)


©️ Copyright


(πŸ‘† back to top πŸ‘†)


About

A collection of scripts designed to enhance the visual appeal of your upcoming Bash script project.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Languages