Version Control Kit

Overview

The AuroraEditor Version Control Kit is a comprehensive tool designed to facilitate version control operations within the AuroraEditor environment. It enables actions such as committing, pulling, pushing, and fetching history for entire files or specific lines of code. This project is an extraction from the main AuroraEditor Repository and is currently under development.

Features (Not limited to the below mentioned)

• Committing Changes: Track and commit changes to your codebase.
• Pulling Updates: Synchronize your local repository with changes from a remote repository.
• Pushing Changes: Send your local commits to a remote repository.
• Fetching History: Access the history of changes for files or individual lines of code.
• Git Services: Allows you to make calls to GitHub, BitBucket and GitLab. (Create an issue if you want more Git providers added.)

Installation

Requirements

• Swift 3.0 or later.
• macOS Monterey or later

Using Swift Package Manager

1. Add Dependency: Edit your Package.swift to include AuroraEditor Version Control Kit as a dependency:

   dependencies: [
    .package(url: "https://github.com/AuroraEditor/Version-Control-Kit.git", from: "Version-0")
   ]

   Else if you want the latest up to date version use the branch name:

   dependencies: [
    .package(url: "https://github.com/AuroraEditor/Version-Control-Kit.git", .branch("main"))
   ]

   Usage

The AuroraEditor Version Control Kit's source code is in the process of being thoroughly documented. While many functions include detailed explanations, cautionary notes, and examples with their requirements, there are some areas still pending comprehensive documentation. These will be addressed and updated in due time. Users can look forward to a future How-To guide that will provide additional structured guidance on using the toolkit's capabilities.

Socials

Licenses

Intellectual Property License

• The AuroraEditor Version Control Logo is the copyright of AuroraEditor and Aurora Company.

GNU Affero General Public License v3.0

• This project is licensed under the GNU AGPL V3 License.