mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-12-25 05:29:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: move installation instructions from tutorial to README

Browse source 
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.
This commit is contained in:
Martin von Zweigbergk 2021-10-13 08:42:29 -07:00
parent 0e3b4b406a
commit 8fef1c2068
2 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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

17
docs/tutorial.md
View file

@ -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 "<dir>/jj-jj"
$ jj git clone https://github.com/martinvonz/jj.git
Fetching into new repo in "<dir>/jj"
Working copy now at: 265ecf5cab2d
$ cd jj-jj
$ cd jj
```
Running `jj st` (short for`jj status`) now yields something like this: