Skip to content

Commit

Permalink
readme: tidy up the front matter a little
Browse files Browse the repository at this point in the history
Summary: Just a small rework of the very top-level frontmatter. Now:

- Uses `<div>` 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 <[email protected]>
Change-Id: I2d92a21650afec0640add3741d4f20c5
  • Loading branch information
thoughtpolice committed Oct 3, 2023
1 parent aa3dfaa commit 90c9cd5
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# Jujutsu VCS
<div class="title-block" style="text-align: center;" align="center">

![](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)
# Jujutsu—a version control system

![](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)
<br/>
![](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)
![](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](#disclaimer)
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Status](#status)
- [Related work](#related-work)
**[Homepage] &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Installation] &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Getting Started Tutorial]**

## Disclaimer
[Homepage]: https://martinvonz.github.io/jj
[Installation]: https://martinvonz.github.io/jj/latest/install-and-setup.html
[Getting Started Tutorial]: https://martinvonz.github.io/jj/latest/tutorial.html

This is not a Google product. It is an experimental version-control system
(VCS). I (Martin von Zweigbergk <[email protected]>) 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).
</div>

## Introduction

Expand All @@ -41,9 +43,19 @@ 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, or want to 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
> <[email protected]>) 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

Expand Down

0 comments on commit 90c9cd5

Please sign in to comment.