doc: README

[?]

5GmofPYrEvoyQd4TVzxBDx6nVSC9mFJSPUziMDirav9D

Apr 25, 2024, 8:31 AM

GGP7A6BVQGKI7CR7NTUVXQE6AGEQTQDQVVWZR4AVSQIZLJMGWOCAC

Dependencies

[2] IRTIDHFH don't show children in changelog
[3] HSCLILFA Update installation instructions
[4] KQF5G7P7 Fix typo in README and move conflict management to long term goals
[5] NL47PGQC Update README
[6] LI4DSL43 moved
[7] FP36UDQA README.md + update dependencies
[8] NCBEWRYE Initialize Repository
[9] XX2BCMKG
[10] 4IGTXYXQ Found a couple of typos in the README.md file. “folloow” -> “follow” “vcse” -> “vsce”
[11] 22ZBCRAN
[*] PISK5MYW Remove --fix from record hook

Change contents

file deletion: pijul-vscode-0.0.1.vsix (----------)

[3.1]→[3.12225521:12225575](∅→∅),[3.12225575]→[3.6112789:6112789](∅→∅)
file deletion: pijul-vscode-0.0.1.vsix (----------)

[3.1]→[3.6112733:6112787](∅→∅),[3.6112787]→[3.1:1](∅→∅)
edit in README.md at line 2

[3.20]

[3.111335]

** Experimental ! **
replacement in README.md at line 18

[3.112202]→[3.12227275:12227387](∅→∅),[3.12227387]→[3.0:30](∅→∅),[3.1191]→[3.0:30](∅→∅)

Pijul for VS Code hasn't been published on the extension marketplace yet, so it needs to be installed manually.
To do so, follow these steps:

[3.112202]

[3.112336]

This extension is available in VS Code marketplace. It requires Pijul.

To install Pijul,:
edit in README.md at line 25

[3.12227578]→[3.12227578:12227882](∅→∅)

3. Clone this repository: `pijul clone https://nest.pijul.com/GarettWithOneR/pijul-vscode`
4. In VS Code, open the Command Palette (Ctrl + Shift + P) and run the "Extensions: Install from VSIX..." command to install the `pijul-vscode-0.0.1.vsix` file in the local directory created by the previous step.
replacement in README.md at line 26

[3.265]→[3.12227883:12227948](∅→∅)

To activate Pijul version control in a folder, use `pijul init`.

[3.265]

[3.301]

To activate Pijul version control in a folder, run `pijul init` in the folder.
replacement in README.md at line 28

[3.302]→[3.12227949:12228054](∅→∅)

Feedback on this extension [is welcome](https://nest.pijul.com/GarettWithOneR/pijul-vscode/discussions).

[3.302]

[3.303]

Feedback on this extension is welcome on Zulip [is welcome](https://nest.pijul.com/pcarbonn/pijul-vscode/discussions).
replacement in README.md at line 56

[3.112863]→[3.12228770:12228797](∅→∅)

3. Create the `.vsix` file

[3.112863]

[3.112888]

3. clone this repository:
replacement in README.md at line 59

[3.12228806]→[3.12228806:12228829](∅→∅)

vsce package --no-yarn

[3.12228806]

[3.12228829]

pijul clone https://nest.pijul.com/pcarbonn/pijul-vscode`
cd pijul-vscode
replacement in README.md at line 63

[3.113067]→[3.12228834:12228934](∅→∅)

4. Add the following hook to your [Pijul config file](https://pijul.org/manual/configuration.html):

[3.113067]

[3.575]

4. Add the following hook to your [Pijul config file](https://pijul.org/manual/configuration.html) for linting:
edit in README.md at line 68

[13.27]

[3.577]

```

5. create a channel for your changes (not `main`)

```bash
pijul fork <your name>
edit in README.md at line 75

[3.581]

[3.12228936]

6. test and build this extension, as in [this example](https://code.visualstudio.com/api/get-started/your-first-extension).

To submit your change:

1. create an account on [The Nest](https://nest.pijul.com/)

2. send me a message to request access to my repository in [this discussion](https://nest.pijul.com/pcarbonn/pijul-vscode/discussions)

3. [create an SSH key](https://www.ssh.com/academy/ssh/keygen) if you don't have one yet, and note where it is stored (e.g. `~/.ssh/id_rsa.pub`)

4. copy your public SSH key to [The Nest](https://nest.pijul.com/pcarbonn?ssh) (possibly use `cat ~/.ssh/id_rsa.pub` to view it)
edit in README.md at line 88

[3.12228938]

5. push your change: `pijul push pcarbonn@ssh.pijul.com:pcarbonn/pijul-vscode`

6. alert me of your submission in [this discussion](https://nest.pijul.com/pcarbonn/pijul-vscode/discussions)