-
Notifications
You must be signed in to change notification settings - Fork 353
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
readme: tidy up the front matter a little
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
1 parent
aa3dfaa
commit a06d26d
Showing
1 changed file
with
63 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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"> | ||
|
|
||
|     | ||
| # Jujutsu—a version control system | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
| <br/> | ||
|    | ||
|  | ||
|  | ||
|  | ||
|
|
||
| - [Disclaimer](#disclaimer) | ||
| - [Introduction](#introduction) | ||
| - [Getting started](#getting-started) | ||
| - [Status](#status) | ||
| - [Related work](#related-work) | ||
| **[Homepage] • ** | ||
| **[Installation] • ** | ||
| **[Getting Started Tutorial]** | ||
|
|
||
| ## Disclaimer | ||
| [Homepage]: https://martinvonz.github.io/jj | ||
| [Installation]: https://martinvonz.github.io/jj/latest/install-and-setup | ||
| [Getting Started Tutorial]: https://martinvonz.github.io/jj/latest/tutorial | ||
|
|
||
| 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 | ||
|
|
||
|
|
@@ -41,9 +43,24 @@ 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 | ||
| [](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. | ||
|
|
||
| > [!IMPORTANT] | ||
| > Jujutsu is an **experimental version control system**. While Git compatibility | ||
| > is stable, and most developers use it daily for all their needs, there may | ||
| > still be work-in-progress features, suboptimal UX, and workflow gaps that make | ||
| > it unusable for your particular use. | ||
| ### News and Updates 📣 | ||
|
|
||
| - **Jan 2023**: Martin gave a presentation about Google's plans for Jujutsu at | ||
| Git Merge 2022! 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 | ||
|
|
||
|
|
@@ -68,7 +85,6 @@ version](https://martinvonz.github.io/jj/prerelease/). You can also get there | |
| from the docs for the latest release by using the website's version switcher. The version switcher is visible in | ||
| the header of the website when you scroll to the top of any page. | ||
|
|
||
|
|
||
| ## Features | ||
|
|
||
| ### Compatible with Git | ||
|
|
@@ -180,3 +196,32 @@ scripts if requested. | |
|
|
||
| There are several tools trying to solve similar problems as Jujutsu. See | ||
| [related work](https://martinvonz.github.io/jj/latest/related-work) for details. | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome outside contributions, and there's plenty of things to do, so | ||
| don't be shy. Please ask if you want a pointer on something you can help with, | ||
| and hopefully we can all figure something out. | ||
|
|
||
| We do have [a few policies and | ||
| suggestions](https://martinvonz.github.io/jj/prerelease/contributing/) | ||
| for contributors. The broad TL;DR: | ||
|
|
||
| - Bug reports are very welcome! | ||
| - Every single patch is code reviewed. | ||
| - Please behave yourself and obey the Community Guidelines. | ||
| - There **is** a mandatory CLA you must agree to. Importantly, it **does not** | ||
| transfer copyright ownership to Google or anyone else; it simply gives us the | ||
| right to safely redistribute and use your changes. | ||
|
|
||
| ### Mandatory Google Disclaimer | ||
|
|
||
| I (Martin von Zweigbergk, <[email protected]>) started Jujutsu as a hobby | ||
| project in late 2019, and it has evolved into my full-time project at Google, | ||
| with several other Googlers (now) assisting development in various capacities. | ||
| That said, **this is not a Google product**. | ||
|
|
||
| ## License | ||
|
|
||
| Jujutsu is available as Open Source Software, under the Apache 2.0 license. See | ||
| [LICENSE](./LICENSE) for details about copyright and redistribution. | ||