mirror of
https://github.com/Ed94/gencpp.git
synced 2024-12-22 15:54:45 -08:00
readme fixes
This commit is contained in:
parent
55427822a0
commit
831b52129d
16
Readme.md
16
Readme.md
@ -6,12 +6,12 @@ The library API is a composition of code element constructors, and a non-standar
|
|||||||
These build up a code AST to then serialize with a file builder, or can be traversed for staged-reflection of C/C++ code.
|
These build up a code AST to then serialize with a file builder, or can be traversed for staged-reflection of C/C++ code.
|
||||||
|
|
||||||
This code base attempts follow the [handmade philosophy](https://handmade.network/manifesto).
|
This code base attempts follow the [handmade philosophy](https://handmade.network/manifesto).
|
||||||
Its not meant to be a black box metaprogramming utility, it should be easy to intergrate into a user's project domain.
|
Its not meant to be a black box metaprogramming utility, it should be easy to integrate into a user's project domain.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* [docs - General](./docs/Readme.md): Overview and additional docs
|
* [docs - General](./docs/Readme.md): Overview and additional docs
|
||||||
* [AST_Design](./docs/AST_Design.md): Overvie of ASTs
|
* [AST_Design](./docs/AST_Design.md): Overview of ASTs
|
||||||
* [AST Types](./docs/AST_Types.md): Listing of all AST types along with their Code type interface.
|
* [AST Types](./docs/AST_Types.md): Listing of all AST types along with their Code type interface.
|
||||||
* [Parsing](./docs/Parsing.md): Overview of the parsing interface.
|
* [Parsing](./docs/Parsing.md): Overview of the parsing interface.
|
||||||
* [Parser Algo](./docs/Parser_Algo.md): In-depth breakdown of the parser's implementation.
|
* [Parser Algo](./docs/Parser_Algo.md): In-depth breakdown of the parser's implementation.
|
||||||
@ -98,8 +98,8 @@ Validation through ast construction.
|
|||||||
Code header = parse_struct( code(
|
Code header = parse_struct( code(
|
||||||
struct ArrayHeader
|
struct ArrayHeader
|
||||||
{
|
{
|
||||||
usize Num;
|
usize Num;
|
||||||
usize Capacity;
|
usize Capacity;
|
||||||
allocator Allocator;
|
allocator Allocator;
|
||||||
};
|
};
|
||||||
));
|
));
|
||||||
@ -114,8 +114,8 @@ No validation, just glorified text injection.
|
|||||||
Code header = code_str(
|
Code header = code_str(
|
||||||
struct ArrayHeader
|
struct ArrayHeader
|
||||||
{
|
{
|
||||||
usize Num;
|
usize Num;
|
||||||
usize Capacity;
|
usize Capacity;
|
||||||
allocator Allocator;
|
allocator Allocator;
|
||||||
};
|
};
|
||||||
);
|
);
|
||||||
@ -131,8 +131,8 @@ All three constrcuton interfaces will generate the following C code:
|
|||||||
```cpp
|
```cpp
|
||||||
struct ArrayHeader
|
struct ArrayHeader
|
||||||
{
|
{
|
||||||
usize Num;
|
usize Num;
|
||||||
usize Capacity;
|
usize Capacity;
|
||||||
allocator Allocator;
|
allocator Allocator;
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user