Skip to content

Commit 195e4ee

Browse files
committed
Changed some content from the README (we have Wiki)
1 parent 180d6da commit 195e4ee

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Reversible Erlang
22

3-
An implementation of the reversible semantics for Erlang.
3+
An implementation of a reversible semantics for Erlang.
44

5-
### Dependencies
5+
## Dependencies
66

7-
This tool does not have any dependencies, but it uses [wx](http://erlang.org/doc/apps/wx/chapter.html), the Erlang binding of wxWidgets, that is now included in Erlang/OTP.
7+
This project uses [wx](http://erlang.org/doc/apps/wx/chapter.html), the Erlang binding of wxWidgets.
8+
Therefore, you might have to [build Erlang/OTP with wxWidgets](http://erlang.org/doc/installation_guide/INSTALL.html#Advanced-configuration-and-build-of-ErlangOTP_Building_Building-with-wxErlang) if you did not in the past, but we recommend you to try to compile and execute the application first.
89

9-
If you have any problem running this application, please make sure that you are using an upgraded version of Erlang/OTP (the tool has been tested with Erlang/OTP 18).
10-
11-
### How to use
10+
## How to use
1211

1312
First, compile the project:
1413
```
@@ -31,17 +30,21 @@ To start using the application:
3130
Then, the initial state of the system will appear in the State window.
3231

3332
You can control the evaluation of a program using two modes:
34-
* **Manual**: Specify a pid and select a firable rule.
33+
* **Manual**: Introduce a `Pid` in the `Pid/MsgId` text box and choose a fireable rule.
3534
* **Automatic**:
36-
* **Forward/Backward**: Given a number of steps N, perform N steps in the selected direction. The fired rules are selected at random.
37-
* **Normalize**: Move the system forward up to a system where the only firable rules are Sched (deliver a message). The fired rules are selected at random.
35+
* **Forward/Backward**: Introduce a number of steps `N` in the `Steps` text box and push the `Forward` or the `Backward` button. Then, `N` evaluation steps will be performed in the chosen direction.
36+
* **Normalize**: Move the system forward up to a system where the only firable rules are Sched (deliver a message).
3837

39-
Both modes can be used interchangeably.
38+
Both modes can be used interchangeably.
4039

41-
### Publications
40+
## Publications
4241

4342
This tool is an implementation of the proposed reversible semantics in these publications:
4443
* Naoki Nishida, Adrián Palacios and Germán Vidal. [A Reversible Semantics for Erlang](http://users.dsic.upv.es/~gvidal/german/lopstr16b/paper.pdf). To be published in *Proceedings of the 26th International Symposium on
4544
Logic-Based Program Synthesis and Transformation*.
4645

4746
[comment]: # (Add pages and year once published --, 2016, pages 28:1-28:18)
47+
48+
## Have questions?
49+
50+
Check the [Wiki](https://github.com/mistupv/rev-erlang/wiki) for more information.

0 commit comments

Comments
 (0)