Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
snaildos authored Aug 7, 2022
1 parent 2440d12 commit bad9ce1
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ By opening a pull request, you agree to the conditions of the [Contributor Licen

# Development

## Running
## Running (Development)

Before running Fifo, please ensure you have **latest** [`Node.js`](https://nodejs.org/en/) and [`YARN`] installed on your machine. You can use NPM but it IS NOT recommended.

Expand All @@ -102,7 +102,7 @@ $ npm i -g windows-build-tools

Yarn:
```bash
$ yarn install --save --legacy-peer-deps # Install needed depedencies.
$ yarn install # Install node modules
$ yarn build # Compile Fifo code and rebuild modules.
$ yarn dev # Run Fifo in development mode
```
Expand All @@ -127,6 +127,32 @@ $ yarn copyright # Generates auto headers for copyright.

More commands can be found in [`package.json`](package.json).

## Running (Without Development Mode (Stable))

Before running Fifo, please ensure you have **latest** [`Node.js`](https://nodejs.org/en/) and [`YARN`] installed on your machine. You can use NPM but it IS NOT recommended.

### Windows

Make sure you have build tools installed. You can install them by running this command as **administrator**:

```bash
$ npm i -g windows-build-tools
```

Yarn:
```bash
$ yarn install # Install node modules
$ yarn build # Compile Fifo code and rebuild modules.
$ yarn start # Run Fifo in development mode
```

NPM: Not recommended
```bash
$ npm install --save --legacy-peer-deps # Install needed depedencies. If you can, please, use yarn install.
$ npm run build # Compile Fifo code and rebuild modules.
$ npm run start # Run Fifo in development mode
```

# Documentation

Guides and the API reference are located in [`docs`](docs) directory.
Expand Down

0 comments on commit bad9ce1

Please sign in to comment.