Skip to content

Commit b04166f

Browse files
committed
chore: standardize repository structure across sibling libraries
- Update Doxyfile PROJECT_NUMBER to 1.2.0 (match latest release) - Set Doxyfile PROJECT_LOGO to doc/nickname-generator.png - Standardize .clang-tidy to match sibling configuration - Add Python entries to .gitignore - Add Related Libraries section to README
1 parent 4bc6094 commit b04166f

4 files changed

Lines changed: 30 additions & 4 deletions

File tree

.clang-tidy

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,17 @@ Checks: >
99
performance-*,
1010
readability-*,
1111
-modernize-use-trailing-return-type,
12-
-readability-identifier-length
12+
-readability-identifier-length,
13+
-cppcoreguidelines-non-private-member-variables-in-classes,
14+
-misc-non-private-member-variables-in-classes,
15+
-cppcoreguidelines-pro-bounds-avoid-unchecked-container-access,
16+
-cppcoreguidelines-avoid-magic-numbers,
17+
-readability-magic-numbers,
18+
-bugprone-exception-escape,
19+
-hicpp-braces-around-statements,
20+
-readability-braces-around-statements,
21+
-readability-math-missing-parentheses,
22+
-misc-include-cleaner
1323
WarningsAsErrors: ''
1424
HeaderFilterRegex: 'dasmig/.*\.hpp'
1525
ExtraArgs: ['-std=c++23']

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,8 @@ doc/api/
2121
Thumbs.db
2222
Desktop.ini
2323
.DS_Store
24+
25+
# Python
26+
__pycache__/
27+
*.pyc
28+
.venv/

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# Run: doxygen Doxyfile
33

44
PROJECT_NAME = "Nickname Generator"
5-
PROJECT_NUMBER = 1.1.0
5+
PROJECT_NUMBER = 1.2.0
66
PROJECT_BRIEF = "Gamer-style nickname generation for C++23"
7-
PROJECT_LOGO =
7+
PROJECT_LOGO = doc/nickname-generator.png
88

99
OUTPUT_DIRECTORY = doc/api
1010
CREATE_SUBDIRS = NO

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,15 @@ my_gen.load("path/to/resources");
9393
std::wstring nick2 = my_gen.get_nickname(L"Own Instance");
9494
```
9595
96-
For the complete feature guide — transforms, word lists, thread safety, and more — see the **[Usage Guide](doc/usage.md)**.
96+
For the complete feature guide — transforms, word lists, thread safety, and more — see the **[Usage Guide](doc/usage.md)**.
97+
98+
## Related Libraries
99+
100+
| Library | Description |
101+
|---------|-------------|
102+
| [name-generator](https://github.com/dasmig/name-generator) | Culturally appropriate full names |
103+
| [birth-generator](https://github.com/dasmig/birth-generator) | Demographically plausible birthdays |
104+
| [biodata-generator](https://github.com/dasmig/biodata-generator) | Procedural human physical characteristics |
105+
| [city-generator](https://github.com/dasmig/city-generator) | Weighted city selection by population |
106+
| [country-generator](https://github.com/dasmig/country-generator) | Weighted country selection by population |
107+
| [entity-generator](https://github.com/dasmig/entity-generator) | ECS-based entity generation |

0 commit comments

Comments
 (0)