Skip to content

Commit

Permalink
Update the commands in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
antoine4livre committed Nov 30, 2023
1 parent 813be98 commit ea2a7d0
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,18 @@ Have a look at the [small guide](https://tailwind-config.meta.fr) for informatio
This project uses [Git Flow](https://github.com/petervanderdoes/gitflow-avh) as a branching model and a combination of [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/) to lint the JS files. You can lint your modifications when contributing with the following commands:

```bash
# Lint all files in the src/ folder
# Lint all files in the packages/ folder
$ npm run lint

# Lint files and test build files
$ npm run test
# Start the dev server for the test's assets
$ npm run test:dev

# Build the test's assets
$ npm run test:build

# Start the dev server for the documentation
$ npm run docs:dev

# Build the documentation
$ npm run docs:build
```

0 comments on commit ea2a7d0

Please sign in to comment.