Ver código fonte

Update_Readme_Raw_Commands

Removed `dev.sh` references from the documentation in favor of raw execution commands.

        PURPOSE:
        To align the documentation with cross-platform best practices and collaborator preferences. Orchestrator scripts (like `dev.sh`) can obscure the build pipeline and create friction for Windows developers who lack native Bash support. By explicitly listing the raw `uv` and `bun` commands, contributors gain granular control over the build process (e.g., executing `bun run build` independently when only modifying TypeScript) and maintain full cross-platform compatibility.

        IMPLEMENTATION DETAILS:
        - Erased all mentions of `dev.sh`.
        - Explicitly listed the 4-step build process (`uv run roi.py`, `bun install`, `bun run build`, and `python3 -m http.server`).
        - Added brief contextual notes to each step so developers understand exactly what each tool is responsible for, explicitly noting the backend's use of `cbor2` for caching.
        - Replaced Markdown fenced code blocks with indented code blocks to circumvent chat UI parser truncation bugs.
Thomas Knott 2 semanas atrás
pai
commit
aee53800eb
1 arquivos alterados com 31 adições e 19 exclusões
  1. 31 19
      readme.md

+ 31 - 19
readme.md

@@ -2,18 +2,17 @@
 
 install uv: [https://docs.astral.sh/uv/getting-started/installation/](https://docs.astral.sh/uv/getting-started/installation/)
 
-get a FIO API key from [https://fio.fnar.net/settings](https://fio.fnar.net/settings) and create a `config.toml` like
-```toml
-username = 'raylu'
-fio_api_key = 'uuid_here'
-punoted_api_key = ''
+get a FIO API key from [https://fio.fnar.net/settings](https://fio.fnar.net/settings) and create a `config.toml` like:
 
-[market.mm_items]
-TCL = 0
+    username = 'raylu'
+    fio_api_key = 'uuid_here'
+    punoted_api_key = ''
 
-[supply.promitor]
-ignore_materials = ['RAT']
-```
+    [market.mm_items]
+    TCL = 0
+
+    [supply.promitor]
+    ignore_materials = ['RAT']
 
 `uv run supply.py promitor`
 
@@ -24,12 +23,25 @@ ignore_materials = ['RAT']
 To work on the frontend (`ts/` directory) and test your changes locally, you will need to install **Bun** (the project's JavaScript runtime and bundler) in addition to `uv`.
 install bun: [https://bun.sh/docs/installation](https://bun.sh/docs/installation)
 
-Run the local development orchestrator script from your terminal:
-```bash
-bash dev.sh
-```
-This script will automatically:
-1. Run `roi.py` (via `uv`) to generate the required backend JSON data.
-2. Ensure frontend dependencies are installed via `bun install`.
-3. Build the TypeScript into standard JavaScript.
-4. Spin up a local development server at `http://localhost:8000`.
+To generate the backend data, compile the frontend, and serve the site locally, execute the following commands from your terminal:
+
+1. **Generate the Backend Data:**
+   Use `uv` to execute the Python script in its isolated environment (this utilizes `cbor2` for efficient API caching).
+
+       uv run roi.py
+
+2. **Install Frontend Dependencies:**
+   Populate the `node_modules` directory with the required JavaScript libraries.
+
+       bun install
+
+3. **Build the Frontend:**
+   Compile the TypeScript files into browser-ready JavaScript within the `www/` directory.
+
+       bun run build
+
+4. **Serve Locally:**
+   Navigate into the web directory and spin up a local development server to view your changes at `http://localhost:8000`.
+
+       cd www
+       python3 -m http.server 8000