pijul_org / pijul

Shell in the README

By pmeunier on March 27, 2019
signed by pmeunier.
Ait2t8nyFJp9Erj7ip6wbtacv2zyja3GwvCtkJ5NF7dzDTJjPJ6XA5CSx8pZkaBry2r2fd6K1yLtP3njHxNyWchS
This patch is in the following branches:
inrepo_type
investigate_conflict
latest
master
reporoot_type
testing
In file README.md
15
16

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

44
45
46
47
48
49
50
51

52
53
54
55
56
57
58
59
60
61
62
63
64
65

66
67
68
69
70
71

72
73
With the latest stable Rust installed, Pijul can also be compiled and installed using:

```
``` .shell
cargo install --force pijul
```

The `--force` flag is used so you can upgrade Pijul if you have a previous version already installed. Once the command has been executed, you can find the `pijul` binary in `~/.cargo/bin/`. You might want to add an alias in your shell profile.

Pijul looks for its configuration in `$PIJUL_CONFIG_DIR` first, then in `$HOME/.pijulconfig` if the former is not set.

## Community

[Our website](https://pijul.org/community) has instructions on how to reach out.

## Feature or bug?

Pijul, like any software, has bugs. In the past, some users have started believing that our bugs are "design choices", and have blamed us for our poor decisions.

If this happens to you, the best thing to do is to talk to us. The Pijul team strongly believes in positive criticism. If you believe something doesn't behave as expected, if the code looks "complex", if you don't understand the documentation, please reach out.

In most cases, it is a bug. In some others, there are very good reasons for some design choices. It might be the case that we found counter-intuitive examples in the past, that break more "natural" or "naive" approaches.

## Contributing

We welcome contributions, even if you understand nothing of patch theory. See the discussions in this repository to find tasks to do.

The first step towards contributing is to *clone the repositories*. Pijul depends on a number of packages maintained by the same team, the two largest ones being [Sanakirja](/pijul_org/sanakirja) and [Thrussh](/pijul_org/thrussh).
Here is how to build and install the pijul repositories:

```
``` .shell
$ pijul clone https://nest.pijul.com/pijul_org/pijul
$ cd pijul
$ cargo build
```

If you want to replace the version installed by Cargo with you own build, it is as simple as:

```
``` .shell
$ cargo install --force --path pijul
```

By contributing, you agree to make all your contributions GPL2+.

Moreover, the main platform for contributing is [the Nest](//nest.pijul.com/pijul_org/pijul), which is still somewhat experimental. Therefore, even though we do our best to avoid it, our repository might be reset, causing the patches of all contributors to be merged. Feel free to add your name in CONTRIBUTORS.md.

If you want to propose a change, you should proceed as follows:

1. Create a [new discussion on the Nest](https://nest.pijul.com/pijul_org/pijul/discussions), to gather feedback on your proposal.
2. Make your change, record a patch (by using `pijul record`).
3. Push it to the Nest. It is *not* necessary (and actually not even useful) to fork the project on the Nest, as changes can be pushed directly to discussions. After creating a discussion, one can push a patch directly to the corresponding branch. For instance, discussion 271 has branch name ":271", and patches can be pushed using:

```
``` .shell
pijul push <user>@nest.pijul.com:pijul_org/pijul --to-branch :271
```

We use `rustfmt` to enforce a coding style on pijul source code. You can have a look at [the `rustfmt` repository](https://github.com/rust-lang-nursery/rustfmt) for how to install it. To be sure not to forget to run `rustfmt` before recording your change, you can use the `pre-hook` hook, by creating an executable file at `.pijul/hooks/pre-record`, with the following content:

```
``` .shell
#!/usr/bin/bash