Skip to content

Commit bc7e53f

Browse files
committed
docs: add info to README
1 parent bb5f7fd commit bc7e53f

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,23 @@ Here are some ways you can use this extension:
5353
[![Download AppImage](https://img.shields.io/badge/Download-Linux%20AppImage-blue?style=for-the-badge)](https://downloads.codetracer.com/CodeTracer-25.07.1-amd64.AppImage)
5454

5555
[![Download macOS](https://img.shields.io/badge/Download-macOS-blue?style=for-the-badge)](https://downloads.codetracer.com/CodeTracer-25.07.1-arm64.dmg)
56-
4. Configure the path to the `codetracer` executable in the extension settings.
56+
4. Configure the path to the `codetracer` executable in the extension settings with `runnablePath` setting.
5757

5858
> **Note:**
5959
> If you are using NixOS you will need an `appimage-run` package in the environment of the running VsCode
60-
60+
> alternatively you can try to build a pure nix package from the developer env of CodeTracer with `just build-nix` and point to its `ct` binary
6161
---
6262

6363
## 🛠 Usage
6464

65+
You need to `Toggle CodeTracer` from the command pallette, or to use its commands from the CodeTracer view in the vscode sibder.
66+
67+
Build/recording is usually done separately with the CodeTracer commands out of the extension, but in some cases one can record+replay the
68+
current file even from the extension.
69+
70+
By default `Toggle CodeTracer` tries to show you available replays, and you can choose going through them, or through
71+
recorded stylus transactions from the sidebar; you can also do those actions:
72+
6573
1. **Record and Run Current File** *(Ruby only)*
6674
- Open a Ruby file and run the **Record and Run Current File** command from the Command Palette.
6775

0 commit comments

Comments
 (0)