verFlow

Welcome to verFlow, a simplified implementation of Git! This project is inspired by the "WYAG" (Write Yourself A Git) project, offering a minimalistic and understandable version of Git's core functionalities.

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License
• Acknowledgements

Introduction

verFlow is a lightweight implementation of Git designed for simplicity and ease of understanding. It replicates the core features of Git, allowing users to grasp the fundamental concepts without the complexity of the full Git system.

Features

• Minimalistic Git Implementation: A stripped-down version of Git focusing on the essential features.
• Core Commands: Supports basic Git commands such as init, add, commit, log, checkout, and more.
• Educational: Ideal for learning and understanding the inner workings of Git.
• Lightweight: Small codebase with minimal dependencies, easy to explore and modify.

Installation

To get started with verFlow, follow these steps:

1. Clone the repository:

   git clone https://github.com/NayanPahuja/verFlow.git

2. Navigate to the project directory:

   cd verFlow

3. Install the necessary dependencies (if any):

   # Example using pip for Python dependencies
   pip install -r requirements.txt

Usage

verFlow supports several core Git commands. Here are a few examples of how to use them:

1. Initialize a new repository:

   ./verFlow init path

2. Add a file to the repository:

    ./verFlow add <file_name>

3. Commit changes:

   ./verFlow commit -m "Commit message"

4. View commit logs:

   ./verFlow log

5. Checkout a commit:

   ./verFlow checkout <commit_hash>

Refer to the help command for a complete list of supported commands and their usage:

./verFlow help

Contributing

I welcome contributions to enhance verFlow! If you have suggestions or improvements, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -m "Description of changes"

4. Push to the branch:

   git push origin feature-name

5. Create a pull request to merge your changes into the main branch.

License

The program is licensed under the terms of the GNU General Public License 3.0, or any later version of the same licence.

Acknowledgements

This project is inspired by the "WYAG" (Write Yourself A Git) project. Special thanks to its creator.

Feel free to modify this README to better fit the specifics of your project. Happy coding!