Skip to content
This repository was archived by the owner on Jul 25, 2022. It is now read-only.

Commit 399e790

Browse files
committed
chore: Add CLI.md
1 parent 367deaf commit 399e790

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## Contributing
22
First, make sure you have Yarn installed on your system.
3+
For information about the CLI, head over to [CLI.md](cli/CLI.md)
34

45
You will need `windows-build-tools` to compile the project. Install it globally (as an administrator) with:
56
- `yarn global add windows-build-tools`

cli/CLI.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Developing the CLI
2+
First, make sure you have Yarn installed on your system.
3+
4+
Then:
5+
1) Install JS dependencies with:
6+
- `yarn`
7+
2) Start the compilation:
8+
- `yarn watch`
9+
3) Run the CLI to test it:
10+
- `yarn start`
11+
12+
You can add any arguments and options: `yarn start --version`.
13+
14+
### Building
15+
To build the CLI, run `yarn dist`. The compiled file is located at `resources/cli/cli.js`

0 commit comments

Comments
 (0)