ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

docs: move initial configuration from tutorial to README

Browse source 
It seems better to have all the one-time setup in the README.
This commit is contained in:
Martin von Zweigbergk 2021-10-13 20:33:17 -07:00
parent e9f57332cc
commit 56e0f1254b
2 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -89,6 +89,15 @@ $ rustup install nightly
$ cargo +nightly install --git https://github.com/martinvonz/jj.git
```
You may also want to configure your name and email so commits are made in your
name. Create a `~/.jjconfig` file and make it look something like this:
```shell script
$ cat ~/.jjconfig
[user]
name = "Martin von Zweigbergk"
email = "martinvonz@google.com"
```
## Getting started

14
docs/tutorial.md
View file

@ -2,18 +2,10 @@
This text assumes that the reader is familiar with Git.
## Setup
## Preparation
First [install Jujutsu](../README.md#Installation).
You may also want to configure your name and email so commits are made in your
name. Create a `~/.jjconfig` file and make it look something like this:
```shell script
$ cat ~/.jjconfig
[user]
name = "Martin von Zweigbergk"
email = "martinvonz@google.com"
```
If you haven't already, make sure you
[install and configure Jujutsu](../README.md#Installation).
## Cloning a Git repo