From c0484987503617d7e4d75497ac6c089ee178c3e2 Mon Sep 17 00:00:00 2001 From: Jason Ojisan Date: Fri, 22 Nov 2024 19:32:29 -0500 Subject: [PATCH] Add build instructions to readme * Add build instructions to readme * Add build option that includes version number * Add license report to build steps OTIxMzZhMGFjNzNjZTZhOTg5N2Q1NzdjNDQ4MjMwOTE3NTQ1MzMzOAo= --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 84f3b7006..92d2ac0a0 100644 --- a/README.md +++ b/README.md @@ -145,6 +145,20 @@ If you want to add or improve support for a language, read the documentation on Feel free to join us on [DJT 🍔](https://tatsumoto.neocities.org/blog/join-our-community). +## Building Rikaitan + +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 Rikaitan uses several third-party libraries to function.