From d37e484fc862f93f94035da8b361633fe9e83433 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Wed, 27 Oct 2021 21:45:37 -0700 Subject: [PATCH] docs: explain what the tool is about, not why I started it --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1102ca4e9..f1bf0c72e 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,17 @@ from Google. ## Introduction -I started the project mostly in order to test the viability of some UX ideas in -practice. I continue to use it for that, but my short-term goal now is to make -it useful as an alternative CLI for Git repos. +Jujutsu is a Git-compatible +[DVCS](https://en.wikipedia.org/wiki/Distributed_version_control). It combines +features from Git (data model, speed), Mercurial (anonymous branching, simple +CLI free from "the index", +[revsets](https://www.mercurial-scm.org/repo/hg/help/revsets)), and Pijul/Darcs +(first-class conflicts), with features not found in either of them +(working-copy-as-a-commit, undo functionality, automatic rebase). The command-line tool is called `jj` for now because it's easy to type and easy to replace (rare in English). The project is called "Jujutsu" because it matches -"jj" (I initially called it "Jujube", but changed since jujutsu is more -well-known). +"jj". Features: