Skip to content

Commit bbbc42b

Browse files
committed
Added installation notes to the ReadMe
1 parent 397bd44 commit bbbc42b

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,34 @@
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 TLS-Attacker, you need to have Java and Maven installed. On Ubuntu you can install Maven by running:
11+
```bash
12+
$ sudo apt-get install maven
13+
```
14+
ModifiableVariable currently needs Java JDK 8 to run. If you have the correct Java version you can install
15+
ModifiableVariable as follows.
16+
```bash
17+
$ git clone https://github.com/tls-attacker/ModifiableVariable.git
18+
$ cd ModifiableVariable
19+
$ mvn clean install
20+
```
21+
22+
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
23+
.xml as follows.
24+
25+
```xml
26+
<dependency>
27+
<groupId>de.rub.nds</groupId>
28+
<artifactId>ModifiableVariable</artifactId>
29+
<version>3.0.0</version>
30+
</dependency>
31+
```
32+
33+
#Usage
34+
35+
The best way to present the functionality of ModifiableVariables is by means of a simple example:
936

1037
```java
1138
ModifiableInteger i = new ModifiableInteger();

0 commit comments

Comments
 (0)