Skip to content

Commit a35277f

Browse files
committed
Merge 368543c
2 parents d75d018 + 368543c commit a35277f

File tree

3 files changed

+38
-4
lines changed

3 files changed

+38
-4
lines changed

AUTHORS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Steven Costiou, Inria <[email protected]>
2+
Adrien Vanègue, Inria <[email protected]>

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Steven Costiou, Adrien Vanègue
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
# Sindarin
2-
Instanciate a UI-less debugger on your execution, allowing you to manipulate and inspect it via scripting.
3-
The API is on the `SindarinDebugger` class.
2+
Sindarin is a versatile and interactive debugger scripting API for object-oriented programming languages. Sindarin is designed to help building dedicated debugging tools targeting specific problems or domains.
3+
To do this, Sindarin attaches to a running process then exposes stepping and introspection operations to control, manipulate and observe that process’ execution.
4+
It simplifies the creation of personalized debugging scripts by providing an AST-based API, thus also proposing different stepping granularity over the debugging session.
5+
Once written, scripts are extensible and reusable on other scenario, and can be used to build more complex debugging tools.
6+
7+
**Research paper:** [Sindarin: A Versatile Scripting API for the Pharo Debugger](https://hal.archives-ouvertes.fr/hal-02280915)
8+
9+
### Main authors
10+
- [Steven Costiou](https://github.com/StevenCostiou) (2019 - ...)
11+
- [Adrien Vanègue](https://github.com/adri09070) (2022 - 2024)
412

5-
- Original author: **Thomas Dupriez** (dupriezt on github)
6-
- Research paper: [Sindarin: A Versatile Scripting API for the Pharo Debugger](https://hal.archives-ouvertes.fr/hal-02280915)
13+
### Original author
14+
- [Thomas Dupriez](https://github.com/dupriezt) (2019 - 2021)
715

816
## Usage
917

18+
Instanciate a UI-less debugger on your execution, allowing you to manipulate and inspect it via scripting.
19+
The API is on the `SindarinDebugger` class.
20+
1021
```Smalltalk
1122
dbg := SindarinDebugger debug: [<your code>].
1223
"Manipulate and inspect the debugged execution by sending messages to dbg"

0 commit comments

Comments
 (0)