Polish README

Author: lsk567

README.md

@@ -10,53 +10,65 @@ This plugin provides OpenTelemetry tracing support for Lingua Franca programs. I
 
 ## Building the Plugin
 
-### Step 1: Build (choose one)
+<a id="step-1-clone"></a>
+### Step 1: Clone the repository with submodules
 
-`build.sh` is a thin wrapper around CMake. Step 1 **configures + builds** (it does not install). Choose one:
+```bash
+git clone --recurse-submodules https://github.com/lf-lang/lf-trace-xronos.git
+cd lf-trace-xronos
+```
 
-#### 1a) Configure/build for the system prefix (default CMake prefix)
+<a id="step-2-dashboard"></a>
+### Step 2: Install the Xronos Dashboard
 
 ```bash
-./build.sh
+pip install xronos-dashboard
 ```
 
-This produces:
-- `lib/liblf-trace-impl.a`
-- A build directory with cached dependencies under `build/_deps/`
+Please see [here](https://docs.xronos.com/dashboard.html#installation) for more information.
+
+<a id="step-3-build"></a>
+### Step 3: Build (choose one)
+
+<a id="option-a"></a>
+#### Option A) Build for the system path (e.g., `/usr/local/`)
+
+```bash
+./build.sh
+```
 
-#### 1b) Configure/build for a user-chosen prefix (install anywhere you like)
+This option gives you the *cleanest* LF programs later (see [5a](#5a)).
 
-Choose any `PREFIX` directory you want. Installation will populate:
-- `<PREFIX>/include`
-- `<PREFIX>/lib`
-- `<PREFIX>/lib/cmake/lf-trace-xronos`
+<a id="option-b"></a>
+#### Option B) Build for a custom path (install anywhere you like)
 
-Example (configure/build for this repo’s `./install` directory; this is what CI uses):
+Example - build for an `install/` directory within the repo:
 
 ```bash
 ./build.sh --prefix "$(pwd)/install"
 ```
 
-### Step 2: Install
+<a id="step-4-install"></a>
+### Step 4: Install
 
-Installing is a separate step (required to use the plugin from LF). Run this after Step 1:
+Installing is a separate step (required to use the plugin from LF). Run this after [Step 3](#step-3-build):
 
 ```bash
 ./build.sh --install
 ```
 
 (Use `sudo` only if your chosen prefix requires it.)
 
-**Note:** Dependencies are cached in `build/_deps/` and won't be re-downloaded on subsequent builds unless you delete that directory.
+<a id="step-5-using"></a>
+## Step 5: Using the Plugin from Lingua Franca (three supported flows)
 
-## Step 3: Using the Plugin from Lingua Franca (three supported flows)
+- If you chose **[Option A](#option-a)** (system prefix), use **[5a](#5a)**.
+- If you chose **[Option B](#option-b)** (user-chosen prefix), use **[5b](#5b)** or **[5c](#5c)**.
 
-- If you chose **1a (system prefix)**, use **3a**.
-- If you chose **1b (user-chosen prefix)**, use **3b** or **3c**.
+<a id="5a"></a>
+### 5a) System package on default CMake search path (cleanest LF file)
 
-### 3a) System package on default CMake search path (cleanest LF file)
-
-Install the plugin to the system prefix (see above), then in your `.lf`:
+Install the plugin to the system prefix, then in your `.lf`:
 
 ```lf
 target C {
@@ -70,11 +82,12 @@ target C {
 
 See a working example in `tests/src/TracePluginSystemPath.lf`.
 
-### 3b) Package + explicit path (no system install; easy to remove)
+<a id="5b"></a>
+### 5b) Package + explicit path (no system install; easy to remove)
 
-Install the plugin to a user-chosen prefix (Step 1b + Step 2), then in your `.lf` set `path` to that prefix.
+Install the plugin to a user-chosen prefix ([Option B](#option-b) + [Step 4](#step-4-install)), then in your `.lf` set `path` to that prefix.
 
-Example (install prefix is this repo’s `./install`, referenced relative to the `.lf` file):
+Example (install prefix is this repo’s `install/`, referenced relative to the `.lf` file):
 
 ```lf
 target C {
@@ -89,9 +102,10 @@ target C {
 
 See a working example in `tests/src/TracePluginUserPath.lf`.
 
-### 3c) Custom CMake integration (most flexible; dev-focused)
+<a id="5c"></a>
+### 5c) Custom CMake integration (most flexible; dev-focused)
 
-Use `plugin.cmake` to link everything from an install directory and pass `LF_TRACE_INSTALL` (set to the Step 1b install prefix):
+Use `plugin.cmake` to link everything from an install directory and pass `LF_TRACE_INSTALL` (set to the [Option B](#option-b) install prefix):
 
 ```lf
 target C {
@@ -136,16 +150,6 @@ The `build.sh` script supports several options:
 - `--install`: Install to the configured prefix
 - `--clean`: Clear top-level CMake cache files (keeps `build/_deps/`)
 
-## Troubleshooting
-
-### Missing symbols at link time
-
-If you encounter linker errors for missing symbols:
-
-1. **CoreFoundation symbols** (macOS): Should be automatically linked by `plugin.cmake`
-2. **c-ares symbols**: Check if c-ares is installed system-wide or ensure it's in the install directory
-3. **Other missing symbols**: Ensure `./build.sh` completed successfully and the install directory contains all libraries
-
 ### Rebuilding dependencies
 
 To force a complete rebuild (including re-downloading dependencies):