Skip to content

Commit 7247927

Browse files
committed
Update README
1 parent 49a9ef8 commit 7247927

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
11
# astr, compile-time array string
22

3-
Example code related to the blog post ['Compile time string literals processing, but why'](https://a4z.gitlab.io/blog/2023/11/04/Compiletime-string-literals-processing.html).
3+
An (opinionated) compile-time string processing library for C++20 and above.
44

5-
There are two examples, getting short file names and getting type names.
5+
If wanted, the code can easily be adapted to C++17.
6+
Feel free to open an issue if you need help with that.
67

7-
- File names work as described in the blog post.
8-
- Type names work for a set of use cases but is not a universal solution or replacement for reflections.
8+
**There are two use-cases demonstrating what this can be used for.**
9+
10+
## Getting short file names as compile time strings
11+
12+
Reproducible and fix size 'strings' of __FILE__ at compile time.
13+
14+
The code is related to the blog post ['Compile time string literals processing, but why'](https://a4z.gitlab.io/blog/2023/11/04/Compiletime-string-literals-processing.html), which describes some more details about this feature.
15+
16+
## Getting type names as compile time strings
17+
18+
There are many ways of faking reflections in C++ to get a typename, and there are several more or less famouse library solutions around this.
19+
20+
The code here shows how that actually works, without being a fully fletched 'library'.
21+
22+
There is also enough functionality to get the type name as a compile-time string and doing customizations that this can be used to solve some real world use cases.
23+
24+
## Documentation
25+
26+
For now, please have a look at the files in [the testing directory](./tests/base).
27+
28+
They should be easy to understand and show how to use the code.

0 commit comments

Comments
 (0)