update readme

2024-10-15 21:56:25 +02:00
parent 2fa1232420
commit 5b909b27e4
1 changed files with 17 additions and 1 deletions
@@ -9,7 +9,15 @@ npm i
 npm run dev
 ```

-Open http://localhost:3000 to browse the output that will hot-reload when you make changes.
+Open `http://localhost:3000` to browse the output that will hot-reload when you make changes.
+
+If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) run:
+
+```
+npm generate:commands
+```
+
+This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head.

 ## Build

@@ -19,6 +27,14 @@ npm run build

 The static output will be in `./out`;

+If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) **run this first**:
+
+```
+npm generate:commands
+```
+
+This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head.
+
 ## Template details

 This documentation was made with [Nextra](https://nextra.site) using the template from here https://github.com/shuding/nextra-docs-template.