Shard

A foss service for clipping your games
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Shard is a project ment to replace other clipping softwares, for a fully opensource alternative.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• flask

  pip install flask

Installation

1. Clone the repo

   git clone https://github.com/Pokeylooted/Shard.git

2. Install requirements using setuptools

   pip install .

(back to top)

Usage

Todo: Add usage

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Finish Readme
• Contributer Guide
• Initial Release
  • Setup framework

See the open 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

Distributed under the GNU License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @Pokeylooted - contact@exorbgn.net

Project Link: https://github.com/Pokeylooted/Shard

(back to top)

Acknowledgments

• xXEpicGamerXx

(back to top)