OXYGENHUB
# c8f955891224 oxygen-vscode / README.md
1.1 KiB · Markdown · last changed Milestone 0.1: source control view, diffs over the oxy: scheme, quick diff, decorations, status bar, commit, quick-pick log; process wrapper with a Node test; packaging 1 month ago renderedsource blame history raw
1
# Oxygen for Visual Studio Code
2
3
Source control integration for Oxygen (`oxy`) repositories: a
4
Source Control view with changes and conflicts, diffs against the working
5
copy's base, quick-diff gutters, explorer decorations, a status bar item, and
6
commit from the input box. The full design, milestone by milestone, is in
7
`docs/spec.md` in this repository.
8
9
## Requirements
10
11
- Visual Studio Code 1.137 or later.
12
- `oxy` 0.1 or later on your PATH, at `~/.local/bin/oxy`, or named in the
13
  `oxygen.path` setting. The extension drives `oxy --json` and never reads
14
  `.oxy/` itself.
15
16
## Building
17
18
```
19
npm install
20
npm run check          # typecheck, bundle, and test against the oxy binary
21
npm run package        # oxygen-vscode-<version>.vsix
22
code --install-extension oxygen-vscode-0.1.0.vsix
23
```
24
25
`npm run watch` rebuilds on change; press F5 in VS Code to launch an
26
Extension Development Host with the bundle.
27
28
## Status
29
30
Milestone 0.1 (read-only plus commit) of the spec. Bookmarks, sync, history,
31
blame, conflicts, subrepos, bisect and trust views follow in 0.2 to 0.6.
32
33
## Licence
34
35
MIT or Apache-2.0, at your option, as for Oxygen itself.