diff --git a/CHANGELOG.md b/CHANGELOG.md index fa3a07d..6a70d06 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Changelog -## Unreleased +## v0.1.0 -- First public release. +- First public release 🎉️ diff --git a/README.md b/README.md index 3251857..67a1e95 100644 --- a/README.md +++ b/README.md @@ -5,81 +5,13 @@ Struct-of-Arrays generator for C++ projects. [![Sponsor](docs/images/badge-sponsor.svg)][sponsor] [![Gitter](docs/images/badge-gitter.svg)][gitter] -- [Installation](#installation) -- [Usage](#usage) -- [Config file options](#config-file-options) -- [License and Attribution](#license-and-attribution) -

-## Installation - -### Prerequisites: - -- Python 3.9+ - -### Then: - -``` -pip install soagen -``` +

+ ✨️ This README is as stub. Please see the HTML documentation: marzer.github.io/soagen✨️ +



-## Usage - -Soagen is a command-line application. - -``` -usage: soagen [-h] [-v] [--version] [--install ] [--werror | --no-werror] - [--color | --no-color] [--clang-format | --no-clang-format] - [--doxygen | --no-doxygen] [--natvis | --no-natvis] [--bug-report] - [configs ...] - - ___ ___ __ _ __ _ ___ _ __ - / __|/ _ \ / _` |/ _` |/ _ \ '_ \ - \__ \ (_) | (_| | (_| | __/ | | | - |___/\___/ \__,_|\__, |\___|_| |_| - __/ | - |___/ v0.0.2 - marzer.github.io/soagen - -Struct-of-Arrays generator for C++ projects. - -positional arguments: - configs zero or more .toml files describing your structures-of-arrays - (wildcards are accepted, e.g. soa/*.toml) - -options: - -h, --help show this help message and exit - -v, --verbose enable very noisy diagnostic output - --version print the version and exit - --install install soagen.hpp into a directory - --werror, --no-werror - treat warnings as errors (default: False) - --color, --no-color use colors in terminal output (default: True) - (the British spelling "colour" is also accepted) - --clang-format, --no-clang-format - attempt to run clang-format on generated code (default: True) - --doxygen, --no-doxygen - include doxygen markup in the generated code (default: False) - --natvis, --no-natvis - generate .natvis files for Visual Studio (default: True) - --bug-report capture all inputs and outputs in a bug-report zip file -``` - -

- -## Config file options - -See the [Configuration options] wiki page. - -

- -## License and Attribution - -This project is published under the terms of the [MIT license](https://github.com/marzer/soagen/blob/main/LICENSE.txt). - -[configuration options]: https://github.com/marzer/soagen/wiki/Configuration-options -[feature request]: https://github.com/marzer/soagen/issues/new [gitter]: https://gitter.im/marzer/community [sponsor]: https://github.com/sponsors/marzer diff --git a/docs/pages/intro.md b/docs/pages/intro.md index 307b0fa..c5f46d6 100644 --- a/docs/pages/intro.md +++ b/docs/pages/intro.md @@ -289,7 +289,7 @@ usage: soagen [-h] [-v] [--version] [--install ] [--werror | --no-werror] \__ \ (_) | (_| | (_| | __/ | | | |___/\___/ \__,_|\__, |\___|_| |_| __/ | - |___/ v0.0.2 - marzer.github.io/soagen + |___/ v0.1.0 - marzer.github.io/soagen Struct-of-Arrays generator for C++ projects. @@ -362,7 +362,7 @@ Now run `soagen`: > soagen src/*.toml -soagen v0.0.2 +soagen v0.1.0 Reading src/entities.toml Running clang-format for src/entities.hpp Writing src/entities.hpp @@ -403,7 +403,7 @@ too: ```plaintext > soagen --install src -soagen v0.0.2 +soagen v0.1.0 Copying soagen.hpp to src All done! ``` @@ -541,7 +541,7 @@ the soagen::emplacer: ```cpp using soagen::emplacer; -e.emplace_back(4, emplacer{ 10, 'A' }, {0,0,0}, {1,0,0,0}); +e.emplace_back(4, emplacer{ 10, 'A' }, vec3{0,0,0}, quaternion{1,0,0,0}); // defaults also work with emplace and emplace_back() e.emplace_back(5, emplacer{ 10, 'B' }); diff --git a/docs/pages/schema.md b/docs/pages/schema.md index c5e190f..2ba852f 100644 --- a/docs/pages/schema.md +++ b/docs/pages/schema.md @@ -1,3 +1,11 @@ @page schema Config File Schema @tableofcontents + + + +@section schema_todo TODO + +This site is brand new - this document is still being written! Check back in a day or so. [emoji smile] + + diff --git a/examples/entities.hpp b/examples/entities.hpp index 9865af0..a5bc2c6 100644 --- a/examples/entities.hpp +++ b/examples/entities.hpp @@ -4,7 +4,7 @@ // See https://github.com/marzer/soagen/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT //---------------------------------------------------------------------------------------------------------------------- -// This file was generated by soagen v0.0.2 - do not modify it directly +// This file was generated by soagen v0.1.0 - do not modify it directly // https://marzer.github.io/soagen //---------------------------------------------------------------------------------------------------------------------- #pragma once @@ -15,8 +15,8 @@ /// @note The code and documentation in this file were generated by soagen - https://marzer.github.io/soagen #include -#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR != 0 - #error soagen version mismatch - expected v0.0.X +#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR < 1 + #error soagen version mismatch - expected v0.1.X #endif SOAGEN_DISABLE_WARNINGS; diff --git a/examples/entities.natvis b/examples/entities.natvis index d9ad51d..c0a650a 100644 --- a/examples/entities.natvis +++ b/examples/entities.natvis @@ -1,6 +1,6 @@ diff --git a/examples/shapes.hpp b/examples/shapes.hpp index 17d643c..10510c5 100644 --- a/examples/shapes.hpp +++ b/examples/shapes.hpp @@ -4,7 +4,7 @@ // See https://github.com/marzer/soagen/blob/master/LICENSE for the full license text. // SPDX-License-Identifier: MIT //---------------------------------------------------------------------------------------------------------------------- -// This file was generated by soagen v0.0.2 - do not modify it directly +// This file was generated by soagen v0.1.0 - do not modify it directly // https://marzer.github.io/soagen //---------------------------------------------------------------------------------------------------------------------- #pragma once @@ -15,8 +15,8 @@ /// @note The code and documentation in this file were generated by soagen - https://marzer.github.io/soagen #include -#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR != 0 - #error soagen version mismatch - expected v0.0.X +#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR < 1 + #error soagen version mismatch - expected v0.1.X #endif SOAGEN_DISABLE_WARNINGS; diff --git a/examples/shapes.natvis b/examples/shapes.natvis index 36605f7..329af43 100644 --- a/examples/shapes.natvis +++ b/examples/shapes.natvis @@ -1,6 +1,6 @@ diff --git a/meson.build b/meson.build index 60a8fd7..8bc5148 100644 --- a/meson.build +++ b/meson.build @@ -6,7 +6,7 @@ project( 'soagen', 'cpp', - version : '0.0.2', + version : '0.1.0', meson_version : '>=0.60.0', license : 'MIT', default_options : [ 'cpp_std=c++17', 'b_ndebug=if-release', 'buildtype=release' ] diff --git a/src/soagen/header_file.py b/src/soagen/header_file.py index c86d76f..6e57fe1 100644 --- a/src/soagen/header_file.py +++ b/src/soagen/header_file.py @@ -106,7 +106,7 @@ def write(self, o: Writer): o( rf''' #include - #if SOAGEN_VERSION_MAJOR != {VERSION[0]} || SOAGEN_VERSION_MINOR != {VERSION[1]} + #if SOAGEN_VERSION_MAJOR != {VERSION[0]} || SOAGEN_VERSION_MINOR < {VERSION[1]} #error soagen version mismatch - expected v{VERSION[0]}.{VERSION[1]}.X #endif ''' diff --git a/src/soagen/hpp/generated/version.hpp b/src/soagen/hpp/generated/version.hpp index 52e5e2f..e4a0a37 100644 --- a/src/soagen/hpp/generated/version.hpp +++ b/src/soagen/hpp/generated/version.hpp @@ -6,6 +6,6 @@ #pragma once #define SOAGEN_VERSION_MAJOR 0 -#define SOAGEN_VERSION_MINOR 0 -#define SOAGEN_VERSION_PATCH 2 -#define SOAGEN_VERSION_STRING "0.0.2" +#define SOAGEN_VERSION_MINOR 1 +#define SOAGEN_VERSION_PATCH 0 +#define SOAGEN_VERSION_STRING "0.1.0" diff --git a/src/soagen/hpp/single/soagen.hpp b/src/soagen/hpp/single/soagen.hpp index ddd5820..14e946c 100644 --- a/src/soagen/hpp/single/soagen.hpp +++ b/src/soagen/hpp/single/soagen.hpp @@ -1,6 +1,6 @@ //---------------------------------------------------------------------------------------------------------------------- // -// soagen.hpp v0.0.2 +// soagen.hpp v0.1.0 // https://github.com/marzer/soagen // SPDX-License-Identifier: MIT // @@ -32,9 +32,9 @@ //******** generated/version.hpp ************************************************************************************* #define SOAGEN_VERSION_MAJOR 0 -#define SOAGEN_VERSION_MINOR 0 -#define SOAGEN_VERSION_PATCH 2 -#define SOAGEN_VERSION_STRING "0.0.2" +#define SOAGEN_VERSION_MINOR 1 +#define SOAGEN_VERSION_PATCH 0 +#define SOAGEN_VERSION_STRING "0.1.0" //******** generated/preprocessor.hpp ******************************************************************************** diff --git a/src/soagen/version.txt b/src/soagen/version.txt index 4e379d2..6e8bf73 100644 --- a/src/soagen/version.txt +++ b/src/soagen/version.txt @@ -1 +1 @@ -0.0.2 +0.1.0 diff --git a/tests/employees.hpp b/tests/employees.hpp index b4e34b9..d9582fa 100644 --- a/tests/employees.hpp +++ b/tests/employees.hpp @@ -1,12 +1,12 @@ //---------------------------------------------------------------------------------------------------------------------- -// This file was generated by soagen v0.0.2 - do not modify it directly +// This file was generated by soagen v0.1.0 - do not modify it directly // https://marzer.github.io/soagen //---------------------------------------------------------------------------------------------------------------------- #pragma once #include -#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR != 0 - #error soagen version mismatch - expected v0.0.X +#if SOAGEN_VERSION_MAJOR != 0 || SOAGEN_VERSION_MINOR < 1 + #error soagen version mismatch - expected v0.1.X #endif SOAGEN_DISABLE_WARNINGS; diff --git a/tests/employees.natvis b/tests/employees.natvis index 9a81822..a639b35 100644 --- a/tests/employees.natvis +++ b/tests/employees.natvis @@ -1,6 +1,6 @@