From 56e0f1254bcbb1a5d45aaa3671c624037f8752ff Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Wed, 13 Oct 2021 20:33:17 -0700 Subject: [PATCH] docs: move initial configuration from tutorial to README It seems better to have all the one-time setup in the README. --- README.md | 9 +++++++++ docs/tutorial.md | 14 +++----------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f7bc8f166..a74271ac4 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/tutorial.md b/docs/tutorial.md index a52192cd9..d0259fff8 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -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