Skip to content

Commit fc4f804

Browse files
committed
Improve README
1 parent 8f1b81e commit fc4f804

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# TwinCAT AdsToJava
22

33
This library is intended for use in ADS client applications written in the Java
4-
programming language.
5-
It was tested on Windows 10 using TwinCAT v3.1.4024.25 and OpenJDK 11.0.14.1.
6-
It has partial support for Tc/BSD using openjdk8-8.362.09.1.
4+
programming language. It was tested on Windows 10 and Tc/BSD 13.2.
75

86
**It consists of two parts:**
97

@@ -26,15 +24,17 @@ installed on your system:
2624
- A Java Development Kit, for example, the
2725
[Microsoft Build of OpenJDK](https://docs.microsoft.com/en-us/java/openjdk/download)
2826
- [Apache Maven](https://maven.apache.org/download.cgi)
29-
- [CMake](https://cmake.org/download/)
30-
- Microsoft Visual C++ ([MSVC](https://visualstudio.microsoft.com/downloads#other)) compiler toolset
27+
- [Microsoft Visual Studio](https://visualstudio.microsoft.com/downloads#other)
28+
with the C++ workload (The 2022 version is recommended)
29+
- [CMake](https://cmake.org/download/) (Might already
30+
be installed as a Visual Studio component)
3131
- The [TwinCAT 3](https://www.beckhoff.com/en-en/products/automation/twincat/)
3232
automation software from Beckhoff Automation
3333

3434
Additional dependencies for the full build:
3535

36-
- An [LLVM](https://llvm.org/builds/) installation that
37-
includes `clang-format`
36+
- [Clang Format](https://llvm.org/builds/) (Might already
37+
be installed as a Visual Studio component)
3838
- [NodeJS](https://nodejs.org/en/download/) for spell checking
3939
based on [cspell](https://www.npmjs.com/package/cspell)
4040

@@ -49,7 +49,7 @@ doas pkg install bash git openjdk8 maven cmake ninja os-generic-userland-devtool
4949
Additional dependencies for the full build:
5050

5151
```sh
52-
doas pkg install bash node npm-node18 llvm
52+
doas pkg install node18 npm-node18 llvm
5353
```
5454

5555
## Build
@@ -76,7 +76,7 @@ bash ./bootstrap.sh
7676
bash ./bootstrap_full.sh
7777
```
7878

79-
The full build also enables all warnings and runs the tests,
79+
The **full build** also enables all warnings and runs the tests,
8080
clang-tidy, code spell check and automated code formatting.
8181
Before running the tests you should activate the
8282
[TestPlc](plc/TestPlc/) project.
@@ -85,8 +85,8 @@ Before running the tests you should activate the
8585
win32 version of the `AdsToJava-3.dll`. Depending on your system,
8686
one of them is copied to the `dist/` directory. You can find
8787
the other version in the `build*/Release` directory.
88-
There is no 32 bit version of Tc/BSD operating system so there is
89-
no need for a 32 bit version of this library on Tc/BSD.
88+
There is no 32 bit version of the Tc/BSD operating system so there
89+
is no need for a 32 bit version of this library on Tc/BSD.
9090

9191
## Samples
9292

0 commit comments

Comments
 (0)