Skip to content

Commit

Permalink
Add build instructions to readme (#1597)
Browse files Browse the repository at this point in the history
* Add build instructions to readme

* Add build option that includes version number

* Add license report to build steps
  • Loading branch information
Kuuuube authored Nov 23, 2024
1 parent e50a50d commit 92136a0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ If you want to add or improve support for a language, read the documentation on

Feel free to join us on the [Yomitan Discord](https://discord.gg/YkQrXW6TXF).

## Building Yomitan

1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).

2. Run `npm ci` to set up the environment.

3. Run `npm run license-report:html` to generate any missing or changed license information.

4. Run `npm run build` for a plain testing build or `npm run-script build -- --all --version {version}` for a release build (replacing `{version}` with a version number).

5. The builds for each browser and release branch can be found in the `builds` directory.

For more information, see [Contributing](./CONTRIBUTING.md#setup).

## Third-Party Libraries

Yomitan uses several third-party libraries to function.
Expand Down

0 comments on commit 92136a0

Please sign in to comment.