From 8fef1c206806dd52051e5073aa16c7ad9c466254 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Wed, 13 Oct 2021 08:42:29 -0700 Subject: [PATCH] docs: move installation instructions from tutorial to README I also changed the instructions to use `cargo install --git` pointing straight to GitHub, so we don't have the naming conflict with the jj repo created in the tutorial. --- README.md | 10 ++++++++++ docs/tutorial.md | 17 ++++------------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4668b176b..f7bc8f166 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,16 @@ workflows and setups different from what I personally use are not well supported. +## Installation + +```shell script +# We need the "nightly" Rust toolchain. This command installs that without +# changing your default. +$ rustup install nightly +$ cargo +nightly install --git https://github.com/martinvonz/jj.git +``` + + ## Getting started The best way to get started is probably to go through diff --git a/docs/tutorial.md b/docs/tutorial.md index dce40cab0..0984d069e 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -4,16 +4,7 @@ This text assumes that the reader is familiar with Git. ## Setup -First install Jujutsu: -```shell script -$ git clone https://github.com/martinvonz/jj.git jj-git -$ cd jj-git -# We need the "nightly" Rust toolchain. This command installs that without -# changing your default. -$ rustup install nightly -$ cargo +nightly install --path . -$ cd .. -``` +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: @@ -30,10 +21,10 @@ Now let's clone the same repo using `jj`: ```shell script # Note the "git" before "clone" (there is no support for cloning native jj # repos yet) -$ jj git clone https://github.com/martinvonz/jj.git jj-jj -Fetching into new repo in "/jj-jj" +$ jj git clone https://github.com/martinvonz/jj.git +Fetching into new repo in "/jj" Working copy now at: 265ecf5cab2d -$ cd jj-jj +$ cd jj ``` Running `jj st` (short for`jj status`) now yields something like this: