From 756b4dae0065ae88254b0fdb04fd518aef2f99b2 Mon Sep 17 00:00:00 2001 From: holly sparkles Date: Tue, 6 Feb 2024 21:02:08 +0100 Subject: [PATCH] docs: update readme to clarify the purpose of this soft-fork --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index b6d3227..d974fa4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ +# sparkle-git + +**⚠️ THIS BRANCH IS HIGHLY UNSTABLE! DO NOT DEVELOP ON THIS BRANCH.** + +**I REBASE AND FORCE PUSH REGULARLY. ⚠️** + +This is a soft fork of [rgit](https://git.inept.dev/~doyle/rgit.git) with features that I wanted that are outside of the scope of the original. This is also a learning project because I am determined to learn Rust and the inner workings of git no matter what. + +## Preview + +[git.holly.sh](https://git.holly.sh) is a live preview of the the `sparkle` branch using the following configuration: + +```toml +root_title = "holly's code mountain" +root_readme = "/config/about.md" +root_description = "ascending towards madness" +logo = "/config/emoji.svg" +logo_alt = "snow-capped mountain emoji" +header = "image" +enable_index_owner = false +clone_prefix = "https://git.holly.sh" +ssh_clone_prefix = "ssh://git@git.holly.sh:/srv/git" +enable_http_clone = true +enable_index_links = true +max_commit_message_length = 120 +max_repo_desc_length = 120 +favicon = "/config/favicon.ico" +css = "/config/sass/style.scss" +``` + +## Development + +Developing on the sparkle branch is easy with the following steps: + +1. Clone the repository +2. Create a new branch based on `sparkle` +3. Do your development and rebase when I do + +Optionally, you can create a new branch based on `main` and cherry-pick changes from `sparkle`. + +**⚠️ DO NOT DEVELOP ON `SPARKLE` A DIVERGENCE -WILL- HAPPEN! ⚠️** + +## Contributing to sparkle-git + +I am open to contributions via [`git-send-email`](https://git-scm.com/docs/git-send-email). + +**NOTE:** Upon obtaining consent, submitted patches that are within the scope of the original also get submitted to upstream! + +## Troubleshooting sparkle-git + +When switching between branches, the application will panic when executing. This is due to a database format mismatch. Deleting the database cache and restarting solves the issue. + +--- + # rgit ## Introduction -- libgit2 1.7.2