Skip to content

Commit 4b1a714

Browse files
authored
Improve documentation
* Docs at least 2 corrections plus matters of style * Simplify the wording of several source files Co-authored-by: Christopher Kormanyos <[email protected]>
1 parent 9d10e00 commit 4b1a714

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ _embedded_-_friendly_ adaptation of the aforementioned work.
2424
The `avr-libstdcpp` port began in 2018 with an initial import
2525
of a GNU/GCC-based C++ standard library from GCC 8.
2626
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.
2828

2929
## Using the library
3030

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.
3232
- 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.
3434
- 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.
3535

3636

@@ -109,7 +109,7 @@ and their main uses includes, but is not limited to,:
109109
With these libraries alone, the entire project can benefit
110110
from a great deal of the standard library's power without compromising
111111
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.
113113
114114
The following non-trivial, real-world example, for instance,
115115
wraps instances of an overly-simplified LED class abstraction
@@ -251,7 +251,7 @@ has been removed.
251251

252252
- **Hashing:** Hashing has been optimized for tiny architectures and uses a rudimentary 16-bit CRC algorithm.
253253

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.
255255
These include `std::chrono::high_resolution_clock` and `std::chrono::steady_clock`. When using
256256
these clocks, it is required to implement the clock's static method
257257
`now()` in a project-specific fashion. This is because
@@ -343,9 +343,10 @@ in the [./examples/numeric](./examples/numeric) directory.
343343
344344
`avr-libstdcpp` is intended for a modern `avr-gcc`
345345
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,
349350
as the older compiler's lexical parser is not capable of
350351
properly handling some of the library's template code.
351352

0 commit comments

Comments
 (0)