https://github.com/risadams/bloomshell

A Bash framework starter kit
https://github.com/risadams/bloomshell

Last synced: 25 days ago
JSON representation

A Bash framework starter kit

• Host: GitHub
• URL: https://github.com/risadams/bloomshell
• Owner: risadams
• License: unlicense
• Created: 2024-01-22T14:16:38.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-01-25T17:00:01.000Z (10 months ago)
• Last Synced: 2024-05-02T05:07:26.719Z (6 months ago)
• Language: Shell
• Size: 1.43 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![Unlicensed][license-shield]][license-url]




[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d83195fc2dff42a3b71c792d4fa044c4)](https://app.codacy.com/gh/risadams/bloomshell/dashboard)






  

    

  


Bloomshell


  


    project_description

    


    

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    


      About The Project

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Roadmap

    
Contributing

    
License

    
Contact

    
Acknowledgments

  


## About The Project

(back to top)


## Getting Started

### Prerequisites

### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/risadams/bloomshell.git

   ```

2. Copy needed files to your working directory

   ```sh

   cp ./bloomshell.sh ./lib  /my-project

   ```

3. Rename the entry point script

   ```sh

   mv /my-project/bloomshell.sh /my-project/my-script.sh

   ```

(back to top)


## Roadmap

See the [open issues](https://github.com/risadams/bloomshell/issues) for a full list of proposed features (and known issues).

(back to top)


## Contributing

Contributions 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 Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

(back to top)


## License

This is free and unencumbered software released into the public domain. See `LICENSE` for more information.

(back to top)


## Contact

- Maintainer: [Ris Adams][maintainer-profile]

- Project Link: [https://github.com/risadams/bloomshell][project-url]

(back to top)


## Acknowledgments

- [ShellSpec](https://github.com/shellspec/shellspec) - BDD Unit testing framework

- [ShellCheck](https://github.com/koalaman/shellcheck) - Static Analysis tooling

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/risadams/bloomshell.svg?style=for-the-badge

[contributors-url]: https://github.com/risadams/bloomshell/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/risadams/bloomshell.svg?style=for-the-badge

[forks-url]: https://github.com/risadams/bloomshell/network/members

[stars-shield]: https://img.shields.io/github/stars/risadams/bloomshell.svg?style=for-the-badge

[stars-url]: https://github.com/risadams/bloomshell/stargazers

[issues-shield]: https://img.shields.io/github/issues/risadams/bloomshell.svg?style=for-the-badge

[issues-url]: https://github.com/risadams/bloomshell/issues

[license-shield]: https://img.shields.io/github/license/risadams/bloomshell.svg?style=for-the-badge

[license-url]: https://github.com/risadams/bloomshell/blob/master/LICENSE

[project-url]: https://github.com/risadams/bloomshell

[maintainer-profile]: https://github.com/risadams