Turning the Installation page more beginner-friendly

[?]
Dec 3, 2020, 6:37 PM
BRV6TU4BE3ZFM6G66UGYHK7SOYWIFZEX46AGZVOUC3GHOZDPZUUAC

Dependencies

  • [2] R66FHFZ7 Fixing a wrong $ sign
  • [3] SCSV2FNS Reboot
  • [4] R2GOU54O Installing on Debian (actually tested on Ubuntu)
  • [5] GLUD3ZVF Generating the reference
  • [6] BA5KMNO5 Updating installation instructions
  • [7] ONXLUQLI Add install instructions for arch
  • [8] OSJ2HIDP Version 1.0.0-alpha.10

Change contents

  • edit in src/reference/clone.md at line 1
    [3.78342]
    # pijul clone
    Clones an existing pijul repository
    ## Usage
    ```
    pijul clone [FLAGS] [OPTIONS] <remote> [--] [path]
    ```
    ## Args
    `<remote>`
    `<path>`
    ## Flags
    `-h, --help`
    Prints help information
    `--lazy`
    only download changes with alive contents
    `-k`
    Do not check certificates
    `-V, --version`
    Prints version information
    ## Options
    `--change <change>`
    clone this change and its dependencies
    `--channel <channel>`
    set the remote channel [default: main]
    `--path <partial-paths>...`
    clone this path
    `--state <state>`
    clone this state
  • replacement in src/installing.md at line 5
    [3.307746][3.307746:307934]()
    The main channel to compile Pijul from source is the Rust Language
    package manager, Cargo. See
    [here](https://www.rust-lang.org/install.html) for installing Cargo
    (which comes with Rust).
    [3.307746]
    [3.307934]
    The main channel to compile **Pijul** from source is the Rust Language
    package manager: **cargo**. You'll need to download **rustup** from [here](https://www.rust-lang.org/tools/install) to install **cargo**.
  • replacement in src/installing.md at line 8
    [3.307935][3.307935:308022]()
    Next you'll need some libraries headers installed on your computer and clang compiler.
    [3.307935]
    [3.308022]
    On installing **cargo**, there are also three different channels to choose from, namely: stable, beta and nightly. You can find more information about it [here](https://rust-lang.github.io/rustup/concepts/channels.html). If you're unsure of which channel to choose, go with *stable* as your default rust toolchain:
  • replacement in src/installing.md at line 10
    [3.308023][3.0:48]()
    On Debian, be sure to install needed libraries:
    [3.308023]
    [3.308070]
    ```
    rustup default stable
    ```
    If you've already installed **rustup** before, make sure to *update* it.
    Next, you'll need the necessary **libraries and header files** installed on your computer and clang compiler:
  • edit in src/installing.md at line 18
    [3.308071]
    [3.308071]
    <br />
    **On Debian:**
  • replacement in src/installing.md at line 26
    [3.54][3.54:85]()
    On OSX, this can be done with:
    [3.54]
    [3.85]
    **On OSX:**
  • replacement in src/installing.md at line 32
    [3.1][3.1:25]()
    On Arch Linux, install:
    [3.1]
    [3.308152]
    **On Arch Linux:**
  • replacement in src/installing.md at line 38
    [3.112][3.112:120]()
    and run
    [3.112]
    [3.120]
    <br />
  • replacement in src/installing.md at line 40
    [3.121][3.121:151]()
    ```
    rustup default stable
    ```
    [3.121]
    [3.151]
    After installing the necessary libraries and header files, it's time to install **Pijul**!
  • replacement in src/installing.md at line 42
    [3.152][3.152:188](),[3.188][3.308153:308202](),[3.308153][3.308153:308202]()
    to set the default rust toolchain.
    Then run the following command in your
    terminal:
    [3.152]
    [3.308202]
    Run the following command in your terminal:
  • replacement in src/installing.md at line 49
    [2.71][3.308:343](),[3.308][3.308:343]()
    variable, for example, add to your
    [2.71]
    [3.343]
    variable. For example: adding the following to your
  • replacement in src/installing.md at line 63
    [3.308390][3.308390:308406]()
    nix-env upgrade
    [3.308390]
    [3.308406]
    nix-env --upgrade
  • replacement in src/installing.md at line 73
    [3.308583][3.308583:308601]()
    if it fails with:
    [3.308583]
    [3.308601]
    If it fails with the following error:
  • replacement in src/installing.md at line 86
    [3.308810][3.308810:308895](),[3.308895][3.427:506]()
    Pijul is packaged in [AUR](https://aur.archlinux.org/packages/pijul/) on Arch Linux.
    However, this package is currently flagged Out-of-date and seems to be broken.
    [3.308810]
    [3.308895]
    Pijul is packaged in [AUR](https://aur.archlinux.org/packages/pijul/); however, this package is currently flagged Out-of-date and seems to be broken.