Skip to content

Update README of main branch #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caldwellb merged 3 commits into from
Oct 17, 2025
Merged

Update README of main branch #23

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c900c65
Added build instructions to README
caldwellb Apr 25, 2025
fb12b0c
Merge pull request #22 from inQWIRE/main
caldwellb Oct 14, 2025
034988b
Updated README
caldwellb Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ To render automatically, use command `Activate ZXViz automatic rendering`. To st

Requires [coq-lsp](https://github.com/ejgallego/coq-lsp/) `0.1.7` for automatic rendering. Syntax of valid terms = valid ZX diagrams in [VyZX](https://github.com/inQWIRE/VyZX). See [src/CoreData/ZXCore](https://github.com/inQWIRE/VyZX/blob/main/src/CoreData/ZXCore.v) for the base definitions, and [src/CoreData/Proportional](https://github.com/inQWIRE/VyZX/blob/main/src/CoreData/Proportional.v) for proportionality definitions.

## Build

- Install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you do not have it already.
- Install vsce using command `npm install -g @vscode/vsce`
- in the source directory for this project, run `npm i`.
- run `vsce package`.
- on running `ls`, you should be able to see `vizx-0.1.4.vsix`.
- If the `code` command is functioning:
- run `code --install-extension vizx-0.1.4.vsix`.
- in the same terminal, run `code .`.
- If the `code` command is not functioning:
- launch an instance of [VSCode](https://code.visualstudio.com/download).
- Navigate to View > Extensions > ... > Install from VSIX.
- Locate the `vizx-0.1.4.vsix` file you just created and select it.
- You should now be able to view `ZXViz` as an extension in the extensions tab, and use it in the required fashion.

## Extension Settings

This extension contributes the following settings:
Expand Down