Skip to content
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.

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

README replaced npm with yarn #203

Merged
merged 1 commit into from
Oct 19, 2021
Merged
Changes from all commits
Commits
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
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ These will link you to the latest builds found in the [releases](https://github.

## Prerequisites
- [Git](https://git-scm.com)
- [Node.js](https://nodejs.org/en/) with `npm`.
- [Node.js](https://nodejs.org/en/)
- [yarn](https://yarnpkg.com)
- Command line of your choice.

## Building
Expand All @@ -79,27 +80,27 @@ This will create a local copy of this repository and navigate you to the root fo
### 2: Install Dependencies
Run this command at the root folder to install dependencies:
```ps
npm i
yarn install
```

### 3: Run Build Script
To run the installer in development mode, simply run the following command:
```ps
npm run dev
yarn dev
```

## Additional Scripts

### Linting
This project uses [ESLint](https://eslint.org/). Run this command to lint your changes:
```ps
npm run lint
yarn lint
```

### Compiling & Distribution

```ps
npm run dist
yarn dist
```

---
Expand Down