Skip to content

Commit c8ffb8a

Browse files
committed
[Java] Update README.
1 parent e399558 commit c8ffb8a

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ storage for later, or real-time, replay.
2020
Performance is the key focus. Aeron is designed to be the highest throughput with the lowest and most predictable
2121
latency of any messaging system. Aeron integrates with
2222
[Simple Binary Encoding (SBE)](https://github.com/real-logic/simple-binary-encoding) for the best possible performance
23-
in message encoding and decoding. Many of the data structures used in the creation of Aeron have been factored out to
23+
for message encoding and decoding. Many of the data structures used in the creation of Aeron have been factored out to
2424
the [Agrona](https://github.com/real-logic/agrona) project.
2525

2626
For details of usage, protocol specification, FAQ, etc. please check out the
@@ -45,7 +45,7 @@ features such as Solarflare ef_vi transport binding for a further 40-60% reducti
4545
1. [Configuration Options](https://github.com/real-logic/aeron/wiki/Configuration-Options)
4646
1. [Channel Specific Configuration](https://github.com/real-logic/aeron/wiki/Channel-Configuration)
4747
1. [Aeron Archive (Durable/Persistent Stream Storage)](https://github.com/real-logic/aeron/wiki/Aeron-Archive)
48-
1. [Aeron Cluster (Fault Toleratant Services)](https://github.com/real-logic/aeron/tree/master/aeron-cluster)
48+
1. [Aeron Cluster (Fault Tolerant Services)](https://github.com/real-logic/aeron/tree/master/aeron-cluster)
4949

5050
### How does Aeron work?
5151

@@ -101,17 +101,16 @@ You require the following to build the C++ API for Aeron:
101101
$ sudo apt-get install libz-dev
102102
```
103103

104-
__Note__: Aeron is supported on Linux, Mac, and Windows. Windows builds require Visual Studio and are being developed
105-
with Visual Studio 2017 with 64-bit builds only. Cygwin, MSys, etc. may work, but are not maintained at this time.
106-
Windows builds require 7z to unzip the zlib source archive.
104+
__Note__: Aeron is supported on Linux, Mac, and Windows. A Windows build requires Visual Studio with 64-bit only.
105+
Windows builds require [7z](https://www.7-zip.org/download.html) to unzip the `zlib` source archive.
107106

108-
For convenience, a script is provided that does a full clean, build, and test of all targets as a Release build.
107+
For convenience, a script is provided that does a clean, build, and test of all targets as a Release build.
109108

110109
```shell
111110
$ ./cppbuild/cppbuild
112111
```
113112

114-
If you are comfortable with using CMake, then a full clean, build, and test looks like:
113+
If you are comfortable with using CMake, then a clean, build, and test looks like:
115114

116115
```shell
117116
$ mkdir -p cppbuild/Debug
@@ -126,7 +125,7 @@ If you are comfortable with using CMake, then a full clean, build, and test look
126125
By default, the C Media Driver is built as part of the C++ Build. However, it can be disabled via the CMake
127126
option `BUILD_AERON_DRIVER` being set to `OFF`.
128127

129-
__Note__: C Media Driver is currently only supported on Mac and Linux (Windows version is experimental).
128+
__Note__: C Media Driver is only supported on Mac and Linux (Windows version is experimental).
130129

131130
For dependencies and other information, see the
132131
[README](https://github.com/real-logic/aeron/blob/master/aeron-driver/src/main/c/README.md).

0 commit comments

Comments
 (0)