Skip to content

Commit 98e254f

Browse files
authored
Update README.md
1 parent cffb9fd commit 98e254f

File tree

4 files changed

+20
-8
lines changed

4 files changed

+20
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Benchmarks](https://img.shields.io/badge/-benchmarks-blue)](https://LinqLover.github.io/squeak-tracedebugger/dev/bench/)
66

77
A lightweight and efficient back-in-time debugger for [Squeak](http://squeak.org/) to trace and retrace past method invocations and state changes.
8+
Powered by [SimulationStudio](https://github.com/LinqLover/SimulationStudio).
89

910
Key features:
1011

@@ -17,34 +18,44 @@ Key features:
1718

1819
![TraceDebugger](https://github.com/LinqLover/squeak-tracedebugger/blob/gh-pages/screenshots/TraceDebugger.png?raw=true)
1920

21+
<small><b>Fun fact:</b> All screenshots are <a href="./.github/workflows/release.yml">CI-generated</a>. Find all other screenshots <a href="https://github.com/LinqLover/squeak-tracedebugger/tree/gh-pages/screenshots">here</a>.</small>
22+
2023
Read the [exposé](./docs/exposé.md) and the [product visions](./docs/product-visions.md) for more details about the aims and USPs of this project.
2124
In the [`studies`](./studies/) folders, you can also find the documentation of all experiments that have been conducted so far.
2225

2326
## Installation
2427

28+
We offer a pre-configured all-in-one image. Please go to the [releases section](https://github.com/LinqLover/squeak-tracedebugger/releases), download and extract the latest `TraceDebugger-*.zip` archive, and execute it.
29+
30+
To install the TraceDebugger manually, evaluate the following in a workspace:
31+
2532
```smalltalk
2633
Metacello new
2734
baseline: 'TraceDebugger';
2835
repository: 'github://LinqLover/squeak-tracedebugger';
36+
get;
2937
load.
3038
```
3139

3240
You can also check out the repository via [Squot](https://github.com/hpi-swa/Squot) and install all dependencies manually.
3341

34-
## Usage
35-
36-
Debug an expression in the Trace Debugger:
42+
To install updates, evaluate the following:
3743

3844
```smalltalk
39-
TraceDebugger openOn: ['\w+' asRegex].
45+
TraceDebugger selfUpdate.
4046
```
4147

42-
Shortcut:
48+
(You can also do this via the [window menu ![window menu](./assets/windowMenuButton.png)](https://github.com/LinqLover/squeak-tracedebugger/blob/gh-pages/screenshots/windowMenu.png) of every trace debugger.)
49+
50+
## Usage
51+
52+
For a quick start, open a normal expression in a debugger and press the new <kbd>Trace it</kbd> button on the right. For a detailed manual on the TraceDebugger, please read the in-image help here:
53+
4354
```smalltalk
44-
[2 / 0] debugTrace.
55+
TraceDebuggerHelp openHelpBrowser.
4556
```
4657

47-
For further examples, see the meta protocol `examples` of the `TraceDebugger` class.
58+
(Again, you can also open this help via the [window menu ![window menu](./assets/windowMenuButton.png)](https://github.com/LinqLover/squeak-tracedebugger/blob/gh-pages/screenshots/windowMenu.png) of every trace debugger.)
4859

4960
## Architecture
5061

@@ -64,7 +75,7 @@ This solution is organized as follows:
6475
</tr>
6576
<tr>
6677
<td><a href="packages/TraceDebugger.package/">TraceDebugger</a></td>
67-
<td>Tracing machinery and UI for the TraceDebugger. Integration into the base system..</td>
78+
<td>Tracing machinery and UI for the TraceDebugger. Integration into the base system. Help contents.</td>
6879
</tr>
6980
<tr>
7081
<td><a href="packages/TraceDebuggerTests.package/">TraceDebuggerTests</a></td>

assets/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You can find all CI-generated screenshots [here](https://github.com/LinqLover/squeak-tracedebugger/tree/gh-pages/screenshots).
File renamed without changes.

assets/windowMenuButton.png

247 Bytes
Loading

0 commit comments

Comments
 (0)