From 9945d0f9120f277622a67875c25da7d8484602a7 Mon Sep 17 00:00:00 2001 From: Pierrot LC Date: Fri, 1 Nov 2024 18:39:23 +0100 Subject: [PATCH] README --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 865c72f..51084a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Buku Merger -Custom Git driver to handle merge conflicts of your [buku](buku) bookmarks. +Custom git driver to handle merge conflicts of your [buku](buku) bookmarks. I had the idea of using git to sync my bookmarks, _which are stored as a SQLite database_. The first merge conflict proved me that it was a bad idea. But @@ -15,7 +15,7 @@ Feel free to use it for your own buku git repository! **From source:** 1. Clone the repository. -1. Install [Gleam](gleam) +1. Install [Gleam](gleam). 1. Run `gleam run -m gleescript`. 1. Add the generated `buku_merger` to your `PATH`. @@ -44,7 +44,7 @@ Where: - `` is the latest common ancestor between the two conflicting databases. To use the tool automatically when there's a conflict, you need to add the driver -to your Git configuration: +to your git configuration: ```gitconfig # .gitconfig or config @@ -71,16 +71,15 @@ Place this file at the root of your buku repository. The merge conflict is handled in two phases: -1. Finds the modified rows from `` w.r.t. `` and apply those +1. Identify rows modified in `` compared to `` and apply those modifications to ``. -1. Finds the new rows from `` that do not exist in `` and them - to it. -1. ~~Finds the removed rows from `` that are still present in `` and +1. Find new rows in `` that do not exist in `` and add them. +1. ~~Find removed rows from `` that are still present in `` and remove them from ``.~~ -The final file `` is what git uses as the merged version of the file. +The final file `` is used by git as the merged version. -_I do not delete the bookmarks anymore as it is too easy to mess everything up._ +_I no longer delete the bookmarks, as it is too easy to mess everything up._ ## Shoutouts