Skip to content

Commit

Permalink
Merge pull request #4560 from snyk/docs/how_to_build
Browse files Browse the repository at this point in the history
docs: update basic build instructions.
  • Loading branch information
PeterSchafer authored Apr 19, 2023
2 parents c074f6c + fd58de0 commit 31d2ca8
Showing 1 changed file with 5 additions and 17 deletions.
22 changes: 5 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,21 @@ git pull --ff-only
If you encounter vague errors without a clear solution at any point, try starting over by cloning a new copy or cleaning the project.

```
npm run clean
make clean
```

## Building

Install project dependencies.
To build the project, run the following command in the root of the repository.

```sh
npm ci
```

Build the project.

```sh
npm run build
make build
```

Ensure the build is working. The version should be `1.0.0-monorepo`.
Run the build binary like this.

```sh
npx . --version
```

For faster rebuilds, you can watch for changes. This command will keep running so you will want to run this in a separate terminal or background.

```
npm run watch
./binary-releases/snyk-macos --version
```

## Running tests
Expand Down

0 comments on commit 31d2ca8

Please sign in to comment.