You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Docs at least 2 corrections plus matters of style
* Simplify the wording of several source files
Co-authored-by: Christopher Kormanyos <[email protected]>
Copy file name to clipboardexpand all lines: README.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,13 @@ _embedded_-_friendly_ adaptation of the aforementioned work.
24
24
The `avr-libstdcpp` port began in 2018 with an initial import
25
25
of a GNU/GCC-based C++ standard library from GCC 8.
26
26
A second import of a GNU/GCC-based C++ standard library from GCC 10
27
-
in 2020 modernized the port to include many modern C++20 features.
27
+
in 2020 modernized the port to include many contemporary C++20 features.
28
28
29
29
## Using the library
30
30
31
-
- Add the `avr-libstdcpp/include` path to the standard `-I` include path(s) of the compiler on the command line.
31
+
- Add the `avr-libstdcpp/include` path to the standard `-isystem` (or `-I`) include path(s) of the compiler on the command line.
32
32
- Upon doing this, include standard library headers in the usual way (i.e., `#include <algorithm>`, `#include <array>`, `#include <cstdint>`, etc.).
33
-
- There are also a handful of source files located in the [src directory](./src). Some of these may potentially be needed.
33
+
- There are also several source files located in the [src directory](./src). Some of these may potentially be needed.
34
34
- For instance, when doing floating-point mathematical calculations with the `<cmath>` library, the file [`math.cc`](./src/math.cc) located [here](./src) needs to be added as a normal source file to your project.
35
35
36
36
@@ -109,7 +109,7 @@ and their main uses includes, but is not limited to,:
109
109
With these libraries alone, the entire project can benefit
110
110
from a great deal of the standard library's power without compromising
111
111
in any way on performance or sleek memory footprint.
112
-
This is because these libaries typically require no additional storage.
112
+
This is because these libaries are typically lean, fast and require no additional storage.
113
113
114
114
The following non-trivial, real-world example, for instance,
115
115
wraps instances of an overly-simplified LED class abstraction
@@ -251,7 +251,7 @@ has been removed.
251
251
252
252
-**Hashing:** Hashing has been optimized for tiny architectures and uses a rudimentary 16-bit CRC algorithm.
253
253
254
-
-**`<chrono>`:** Only certain selected the clock functions of`<chrono>` library are implemented.
254
+
-**`<chrono>`:** Only certain judiciously selected clock functions from the`<chrono>` library are implemented.
255
255
These include `std::chrono::high_resolution_clock` and `std::chrono::steady_clock`. When using
256
256
these clocks, it is required to implement the clock's static method
257
257
`now()` in a project-specific fashion. This is because
@@ -343,9 +343,10 @@ in the [./examples/numeric](./examples/numeric) directory.
343
343
344
344
`avr-libstdcpp` is intended for a modern `avr-gcc`
345
345
such as the 11.2 port available in the [modm-io project](https://github.com/modm-io/avr-gcc)
346
-
repository. Tests show usability also for `avr-gcc` 10.
347
-
Using the port way back to `avr-gcc` 5, for instance, does not work
348
-
at the moment in today's form of the checked-in library,
346
+
repository. Tests show usability also for `avr-gcc` 10 through 13 (and beyond).
347
+
348
+
Using the port way back to `avr-gcc` 5, however, does not work
349
+
at the moment with today's form of the checked-in library,
349
350
as the older compiler's lexical parser is not capable of
350
351
properly handling some of the library's template code.
0 commit comments