From 2a901cd6e12b97de53bd39de48f8cbe4ee6b1b7b Mon Sep 17 00:00:00 2001 From: Austin Seipp Date: Tue, 19 Sep 2023 11:20:05 -0500 Subject: [PATCH] readme: tidy up the front matter a little Summary: Just a small rework of the very top-level frontmatter. Now: - Uses `
` to center things a little - Adds top-level links to the new homepage, installation guide, and tutorial - Reworks the disclaimer and 'Introduction' section. After all, a README should first say what the project is! I think this reads much better. Signed-off-by: Austin Seipp Change-Id: I2d92a21650afec0640add3741d4f20c5 --- README.md | 66 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 39 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 01a3e54300..1fe86aec25 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,61 @@ -# Jujutsu VCS +
-![](https://img.shields.io/github/license/martinvonz/jj) ![](https://img.shields.io/github/v/release/martinvonz/jj) ![](https://img.shields.io/github/release-date/martinvonz/jj) ![](https://img.shields.io/crates/v/jj-cli) -
-![](https://github.com/martinvonz/jj/workflows/build/badge.svg) ![](https://img.shields.io/codefactor/grade/github/martinvonz/jj/main) ![](https://img.shields.io/librariesio/github/martinvonz/jj) +# Jujutsu — a version control system -- [Disclaimer](#disclaimer) -- [Introduction](#introduction) -- [Getting started](#getting-started) -- [Status](#status) -- [Related work](#related-work) +![](https://img.shields.io/github/license/martinvonz/jj) +![](https://img.shields.io/github/v/release/martinvonz/jj) +![](https://img.shields.io/github/release-date/martinvonz/jj) +![](https://img.shields.io/crates/v/jj-cli) +
![](https://github.com/martinvonz/jj/workflows/build/badge.svg) +![](https://img.shields.io/codefactor/grade/github/martinvonz/jj/main) +![](https://img.shields.io/librariesio/github/martinvonz/jj) -## Disclaimer + + Homepage +   •   + Installation +   •   + Getting Started + Tutorial + -This is not a Google product. It is an experimental version-control system -(VCS). I (Martin von Zweigbergk ) started it as a hobby -project in late 2019. That said, this is now my full-time project at Google. My -presentation from Git Merge 2022 has information about Google's plans. See the -[slides](https://docs.google.com/presentation/d/1F8j9_UOOSGUN9MvHxPZX_L4bQ9NMcYOp1isn17kTC_M/view) -or the [recording](https://www.youtube.com/watch?v=bx_LGilOuE4). +
## Introduction -Jujutsu is a -[Git-compatible](https://martinvonz.github.io/jj/latest/git-compatibility) -[DVCS](https://en.wikipedia.org/wiki/Distributed_version_control). It combines +Jujutsu is a [Distributed Version Control System](https://en.wikipedia.org/wiki/Distributed_version_control) that is [Git-compatible](https://martinvonz.github.io/jj/latest/git-compatibility). It combines features from Git (data model, [speed](https://github.com/martinvonz/jj/discussions/49)), Mercurial (anonymous -branching, simple CLI [free from "the -index"](https://martinvonz.github.io/jj/latest/git-comparison#the-index), +branching, simple CLI +[free from "the index"](https://martinvonz.github.io/jj/latest/git-comparison#the-index), [revsets](https://martinvonz.github.io/jj/latest/revsets), powerful -history-rewriting), and Pijul/Darcs ([first-class -conflicts](https://martinvonz.github.io/jj/latest/conflicts)), with features not -found in most of them +history-rewriting), and Pijul/Darcs +([first-class conflicts](https://martinvonz.github.io/jj/latest/conflicts)), +with features not found in most of them ([working-copy-as-a-commit](https://martinvonz.github.io/jj/latest/working-copy), [undo functionality](https://martinvonz.github.io/jj/latest/operation-log), -automatic rebase, [safe replication via `rsync`, Dropbox, or distributed file +automatic rebase, +[safe replication via `rsync`, Dropbox, or distributed file system](https://martinvonz.github.io/jj/latest/technical/concurrency)). 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". -If you have any questions, please join us on Discord +Jujutsu is relatively young, with lots of work to still be done. If you have any +questions, want to solicit advice, or talk about future plans, please join us on +Discord [![Discord](https://img.shields.io/discord/968932220549103686.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/dkmfj3aGQN) -or start a [GitHub Discussion](https://github.com/martinvonz/jj/discussions). +or start a [GitHub Discussion](https://github.com/martinvonz/jj/discussions) +— the developers monitor both channels. + +> 🚧 **NOTE** 🚧: This is not a Google product. It is an experimental +> version-control system (VCS). I (Martin von Zweigbergk +> ) started it as a hobby project in late 2019. That +> said, this is now my full-time project at Google. My presentation from Git +> Merge 2022 has information about Google's plans. See the +> [slides](https://docs.google.com/presentation/d/1F8j9_UOOSGUN9MvHxPZX_L4bQ9NMcYOp1isn17kTC_M/view) +> or the [recording](https://www.youtube.com/watch?v=bx_LGilOuE4). ## Getting started