Skip to content

Commit 9d10cfd

Browse files
authored
Merge pull request #57 from tls-attacker/updateReadMe
Update read me
2 parents caafc0d + 0ba6b8e commit 9d10cfd

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,35 @@
55

66
Modifiable variable allows one to set modifications to basic types after or before their values are actually determined. When their actual values are determined and one tries to access the value via getters, the original value will be returned in a modified form accordingly.
77

8-
The best way to present the functionality of this concept is by means of a simple example:
8+
#Installation
9+
10+
In order to compile and use ModifiableVariable, you need to have Java and Maven installed. On Ubuntu you can install
11+
Maven by running:
12+
```bash
13+
$ sudo apt-get install maven
14+
```
15+
ModifiableVariable currently needs Java JDK 8 to run. If you have the correct Java version you can install
16+
ModifiableVariable as follows.
17+
```bash
18+
$ git clone https://github.com/tls-attacker/ModifiableVariable.git
19+
$ cd ModifiableVariable
20+
$ mvn clean install
21+
```
22+
23+
If you want to use this project as a dependency, you do not have to compile it yourself and can include it in your pom
24+
.xml as follows.
25+
26+
```xml
27+
<dependency>
28+
<groupId>de.rub.nds</groupId>
29+
<artifactId>ModifiableVariable</artifactId>
30+
<version>3.1.0</version>
31+
</dependency>
32+
```
33+
34+
#Usage
35+
36+
The best way to present the functionality of ModifiableVariables is by means of a simple example:
937

1038
```java
1139
ModifiableInteger i = new ModifiableInteger();

0 commit comments

Comments
 (0)