Git Automater
Git Automater: Your Shortcut to Seamless Version Control!
Explore the docs ยป
Report Bug
.
Request Feature
![Downloads](https://img.shields.io/github/downloads/ShyamSundhar1411/git-automater/total) ![Contributors](https://img.shields.io/github/contributors/ShyamSundhar1411/git-automater?color=dark-green) ![Forks](https://img.shields.io/github/forks/ShyamSundhar1411/git-automater?style=social) ![Stargazers](https://img.shields.io/github/stars/ShyamSundhar1411/git-automater?style=social) ![Issues](https://img.shields.io/github/issues/ShyamSundhar1411/git-automater) ![License](https://img.shields.io/github/license/ShyamSundhar1411/git-automater)
## Table Of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installing](#installing)
* [Contributing](#contributing)
* [License](#license)
## About The Project
![demo](https://us-east-1.tixte.net/uploads/shyamsundhar.tixte.co/2023-11-12_18-16-40.gif)
There are a lot of processes and commands that are involved in github. Remembering those takes time and indeed version controlling is an important trait for every programmer. In order to reduce the time consumption in using git in local environment, I have created this crate so that it eases the process of version controlling. This crate involves a lot of git processes.
Here are few:
* Initialize Git Repository
* Add Files
* Commit
* Push
* Add License
* Add .gitignore
* Branch Manager
* Clear Cache
* Exit Prompt
## Built With
* [rust](https://www.rust-lang.org/)
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This crate requires the installation of cargo package manager and rust.
* cargo
* rust
For more information, kindly refer the [Documentation](https://www.rust-lang.org/tools/install) for installation procedures.
### Installing
#### Using Cargo
```bash
cargo install git-automater
```
#### Using Source
```bash
git clone https://github.com/ShyamSundhar1411/git-automater.git
cd git-automater
cargo install --path
```
## Roadmap
See the [open issues](https://github.com/ShyamSundhar1411/git-automater/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/ShyamSundhar1411/git-automater/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
* Please make sure you check your spelling and grammar.
* Create individual PR for each suggestion.
### Creating A Pull Request
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
## License
Distributed under the MIT License. See [LICENSE](https://github.com/ShyamSundhar1411/git-automater/blob/master/LICENSE) for more information.