forked from mirrors/jj
readme: tidy up the front matter a little
Summary: Reintroduce 4acdf726 without spurious formatted changes. (This means I
don't have to go back over things with a fine comb.)
Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I18ec68722362a2a64b99a368d3f25cf5
This commit is contained in:
Austin Seipp
parent
706c5026f6
commit
b66adb4bb7
1 changed files with 63 additions and 18 deletions
81
README.md
81
README.md
|
|
@ -1,23 +1,25 @@
|
||||||
# Jujutsu VCS
|
<div class="title-block" style="text-align: center;" align="center">
|
||||||
|
|
||||||
   
|
# Jujutsu—a version control system
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
  
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- [Disclaimer](#disclaimer)
|
**[Homepage] • **
|
||||||
- [Introduction](#introduction)
|
**[Installation] • **
|
||||||
- [Getting started](#getting-started)
|
**[Getting Started Tutorial]**
|
||||||
- [Status](#status)
|
|
||||||
- [Related work](#related-work)
|
|
||||||
|
|
||||||
## 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
|
</div>
|
||||||
(VCS). I (Martin von Zweigbergk <martinvonz@google.com>) 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
|
## 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
|
to replace (rare in English). The project is called "Jujutsu" because it matches
|
||||||
"jj".
|
"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)
|
[](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
|
## 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
|
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.
|
the header of the website when you scroll to the top of any page.
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Compatible with Git
|
### Compatible with Git
|
||||||
|
|
@ -180,3 +196,32 @@ scripts if requested.
|
||||||
|
|
||||||
There are several tools trying to solve similar problems as Jujutsu. See
|
There are several tools trying to solve similar problems as Jujutsu. See
|
||||||
[related work](https://martinvonz.github.io/jj/latest/related-work) for details.
|
[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 commit that lands in the `main` branch 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, <martinvonz@google.com>) 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.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue