From db192218f3453f0c6031361658d9e2926011c0e4 Mon Sep 17 00:00:00 2001 From: pizzaboxer Date: Wed, 9 Oct 2024 22:04:50 +0100 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a4c07dd..f146b69 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# builder -Build tool for translators +# Builder +Bloxstrap build tool made specifically for translators, allowing for easy QA of translations by being able to test them in context. + +## Using Builder +When using it for the first time, there are two things you need to: +- [Configure Crowdin](#configuring-crowdin) +- Set a language. Enter `list languages` to see all available languages, then set one by entering `set language `. + +Afterwards, it's as simple as entering `build` to build, and `run` to run your latest build. + +## QA Builds + +Builder produces a special QA build of Bloxstrap. It is completely separate from your standard Bloxstrap installation, and makes it easier to check coverage and freely test things. + +Remember that Bloxstrap takes over as the web launch handler whenever the bootstrapper is ran. If the QA build is registered as the web launch handler and you want to return it back to standard Bloxstrap, simply launch Roblox from standard Bloxstrap once. + +## Configuring Crowdin + +A Crowdin API token is required to fetch translations. You will need to configure Builder to use one for your own account. + +To create one, go to your Crowdin account settings, go to the API tab, and click "Create Token" under Personal Access Tokens. + +You must grant read/write access for the "Projects" scope. + +![image](https://github.com/user-attachments/assets/45dc85a1-0411-48c1-aba4-52033c91310c) + +Copy the token it gives you, enter `configure crowdin` in Builder, and paste in the token. + +![image](https://github.com/user-attachments/assets/9943e549-ba24-4e1b-b05b-1e56540b46e7)