readme.md 2.04 KB
Newer Older
Georg Graßnick's avatar
Georg Graßnick committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# BraillePlot

A tool to create Braille embosser ready text files for generic diagram representations.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

You will need the following tools to build the project:
* JavaJDK >= 11
* gradle >= 4.4
14
15
16
17
18
19
20
21
22
23
* git

#### Build preparation

Use the following commands to setup your local source tree:

```bash
git clone ${URL_OF_THIS_REPO}
git submodule update --init --recursive # This will fetch third party dependencies
```
Georg Graßnick's avatar
Georg Graßnick committed
24
25
26
27
28
29
30
31
32
33
34

### Installing

Just run
```
gradle jar
```

to create an executable jar file in `build/libs` which will include all runtime dependencies.


35
### Running the tests
Georg Graßnick's avatar
Georg Graßnick committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

A simple call of
```
gradle test
```

will suffice.


### And coding style tests


```
gradle check
```

will execute the checkstyle plugin which will export any flaws registered.
Results will be available on the command line as well as html exports in `build/reports/checkstyle`.

Please fix all the reported issues before opening merge requests, or start a discussion if you are convinced certain rules are too strict.

## Contributing

There is no research branch - use the wiki for advanced documentation.

This project follows the github workflow [[1](https://guides.github.com/introduction/flow/), [2](http://scottchacon.com/2011/08/31/github-flow.html)].
Please create feature branches off of the `master` branch and open merge requests for reviewing purposes.


Branch names sould follow the following convention:
`$Prefix/$Description-$Issue_number`, where

* `$Prefix` is either
    * `feat` when introducing a new feature
    * `bug` when fixing a bug

* `Description` is a short summary of the applied change (use underscores (`_`) to separate multiple words, if needed)

* `$Issue_number` is the associated issue id



## Authors

In alphabetical order:
* Georg Graßnick
* Leonard Kupper
* Andrey Ruzhanskiy
* Richard Schmidt

## License

Georg Graßnick's avatar
Georg Graßnick committed
88
89
90
Licensed under the GPL-3.0.

See [LICENSE](LICENSE).
Georg Graßnick's avatar
Georg Graßnick committed
91
92
93
94

## Acknowledgments

No information yet.