Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
pierrot-lc committed Nov 1, 2024
1 parent 7908de8 commit a32260c
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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`.

Expand Down Expand Up @@ -44,7 +44,7 @@ Where:
- `<base>` 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
Expand All @@ -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 `<other>` w.r.t. `<current>` and apply those
1. Identify rows modified in `<other>` compared to `<base>` and apply those
modifications to `<current>`.
1. Finds the new rows from `<other>` that do not exist in `<current>` and them
to it.
1. ~~Finds the removed rows from `<other>` that are still present in `<base>` and
1. Find new rows in `<other>` that do not exist in `<current>` and add them.
1. ~~Find removed rows from `<other>` that are still present in `<base>` and
remove them from `<current>`.~~

The final file `<current>` is what git uses as the merged version of the file.
The final file `<current>` 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

Expand Down

0 comments on commit a32260c

Please sign in to comment.