Update README

[?]

Dec 29, 2020, 12:05 AM

NL47PGQCDBXEZSY3AFX6BDSQD7EEO4EEMB7C6HBRDXUYMVGTG7LQC

Dependencies

[2] NCBEWRYE Initialize Repository

Change contents

replacement in README.md at line 1

[2.111016]→[2.111017:111039](∅→∅)

# pijul-vscode README

[2.111016]

[2.111039]

# Pijul for VS Code
replacement in README.md at line 3

[2.111040]→[2.111040:111179](∅→∅)

This is the README for your extension "pijul-vscode". After writing up a brief description, we recommend including the following sections.

[2.111040]

[2.111179]

Pijul for VS Code is an extension for Visual Studio Code which adds integration with Pijul as a source control management system.
replacement in README.md at line 5

[2.111180]→[2.111180:111192](∅→∅)

## Features

[2.111180]

[2.111192]

Why develop my own extension instead of contributing to the existing one? It didn't even occur to me to check if one already existed
when I started, and when I did my own extension had enough distinct features to set it apart.
replacement in README.md at line 8

[2.111193]→[2.111193:111335](∅→∅)

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

[2.111193]

[2.111335]

## Features
replacement in README.md at line 10

[2.111336]→[2.111336:111419](∅→∅)

For example if there is an image subfolder under your extension project workspace:

[2.111336]

[2.111419]

At present, this extension offers *most* of the basic features necessary for local Pijul development on a single channel. It includes basic
commands for initializing a repository in a VS Code workspace.
replacement in README.md at line 13

[2.111420]→[2.111420:111460](∅→∅)

\!\[feature X\]\(images/feature-x.png\)

[2.111420]

[2.111460]

- Add, Reset, or Record one, some, or all of the files in the Pijul Repository.
- Decorations in the file tree indicating the current state of each file.
replacement in README.md at line 16

[2.111461]→[2.111461:111629](∅→∅)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

[2.111461]

[2.111629]

Everything else still needs to be done on the command line.
edit in README.md at line 19

[2.111646]→[2.111646:111786](∅→∅)

If you have any requirements or dependencies, add a section describing those and how to install and configure them.

## Extension Settings
replacement in README.md at line 20

[2.111787]→[2.111787:111896](∅→∅)

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

[2.111787]

[2.111896]

Requires an existing Pijul installation. [Instructions for installing Pijul can be found here](https://pijul.org/manual/installing.html).
edit in README.md at line 22

[2.111897]→[2.111897:112071](∅→∅)

For example:

This extension contributes the following settings:

* `myExtension.enable`: enable/disable this extension
* `myExtension.thing`: set to `blah` to do something
replacement in README.md at line 24

[2.112088]→[2.112088:112183](∅→∅)

Calling out known issues can help limit users opening duplicate issues against your extension.

[2.112088]

[2.112183]

I don't know of any major issues, but I will keep this section updated if any are reported.
replacement in README.md at line 26

[2.112184]→[2.112184:112201](∅→∅)

## Release Notes

[2.112184]

[2.112201]

## Installation
replacement in README.md at line 28

[2.112202]→[2.112202:112336](∅→∅)

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

[2.112202]

[2.112336]

Pijul for VS Code hasn't been published on the extension marketplace yet, so it needs to be built and installed from the source.
To do so, folloow these steps:
replacement in README.md at line 31

[2.112337]→[2.112337:112365](∅→∅)

Added features X, Y, and Z.

[2.112337]

[2.112365]

1. Clone the repository
2. Install Visual Studio Code Extensions (VSCE)
```
npm install -g vsce
```
3. Package the extension
```
vcse package
```
4. In VS Code, open the Command Palette (Ctrl + Shift + P) and run the "Extensions: Install from VSIX..." to install the VSIX file you created in the last step
replacement in README.md at line 42

[2.112366]→[2.112366:112474](∅→∅)

-----------------------------------------------------------------------------------------------------------

[2.112366]

[2.112474]

## Roadmap
replacement in README.md at line 44

[2.112475]→[2.112475:112500](∅→∅)

## Working with Markdown

[2.112475]

[2.112500]

With the eventual goal of releasing on the Extension Marketplace with the same level of quality as other source control extensions,
there are a number of areas which will require a great deal of further refinement:
- Proper handling of VS Code workspaces with multiple folders
- Automatic detection of Pijul installations
- More robust .ignore file handling
- Greater configurability
replacement in README.md at line 51

[2.112501]→[2.112501:112613](∅→∅)

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

[2.112501]

[2.112613]

There are also a number of Pijul features which still need implementation to reach a publishable minimum viable product, suitable for local Pijul development:
- Amending changes
- Moving and removing files
- Ignore file mangagement
- Basic change log
- Basic channel management
replacement in README.md at line 58

[2.112614]→[2.112614:112862](∅→∅)

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

[2.112614]

[2.112862]

In the long term, I would like to offer more in-depth Pijul integration, with the goal of providing a better experience than can be offered on the command line:
- Remote management
- Inline `pijul credit` annotations
- Inline `pijul diff` comparison
- IntelliJ style changeset system
- Splitting/Combining existing changes
replacement in README.md at line 65

[2.112863]→[2.112863:112888](∅→∅)

### For more information

[2.112863]

[2.112888]

Each category probably could probably fit a couple more points that I haven't thought of.
replacement in README.md at line 67

[2.112889]→[2.112889:113066](∅→∅)

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

[2.112889]

[2.113066]

## Contributing
replacement in README.md at line 69

[2.113067]→[2.113067:113078](∅→∅)

**Enjoy!**

[2.113067]

Pijul for VS Code welcomes all contributions. Before contributing, please be sure to add the following hook to your Pijul config file:
```
[hooks]
record = ["yarn run lint --fix"]
```