Skip to content

Commit 57570d1

Browse files
authored
Update README.md
Added hint for "how to use" section to the top of the readme.
1 parent e82961a commit 57570d1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A format description based on Google protobuf. The format is used for controlling a laser in combination with a galvanometer scanner. It supports multi scanfield arrays as well as additional machine axis controls.
44

5+
If you are just looking for a "How to use", please scroll to the last section of the readme!
6+
57
## Why another format?
68

79
The first question to adress is for course: why another format? Often, the introduction of a new format to "unify all the existing ones" leads to a situation of there just being yet another format, as beautifully shown in this [xkcd](https://xkcd.com/927/).
@@ -75,4 +77,4 @@ The OpenVectorFormat description is based on Google Protobuf. Protobuf already s
7577
## How to use
7678
The recommended way to use OpenVectorFormat in your software is to use our reference implementation [OpenVectorFormatTools](https://github.com/Digital-Production-Aachen/OpenVectorFormatTools). It provides basic tooling for a seamless integration in C#, e.g. a file reader / writer with streaming support, consistency checks for jobs, and a gRPC wrapper for easy use with other languages.
7779

78-
If you prefer not to use those tools, you can either use the [Workspace](WORKSPACE) file to pull & build standalone versions of the Protobuf & gRPC libraries in your `bazel` workflow. Or just take the [open_vector_format.proto](open_vector_format.proto) file directly. In this case, you should be knowing what you are doing since you need to integrate the protobuf and gRPC libraries manually into your software.
80+
If you prefer not to use those tools, you can either use the [Workspace](WORKSPACE) file to pull & build standalone versions of the Protobuf & gRPC libraries in your `bazel` workflow. Or just take the [open_vector_format.proto](open_vector_format.proto) file directly. In this case, you should be knowing what you are doing since you need to integrate the protobuf and gRPC libraries manually into your software.

0 commit comments

Comments
 (0)