ed/refactor
1
0
Fork 0
mirror of https://github.com/Ed94/refactor.git synced 2025-06-15 03:01:49 -07:00
Code Issues Packages Projects Releases Wiki Activity

fixing grammatical mistakes

Browse Source
This commit is contained in:
Edward R. Gonzalez
2023-03-17 02:19:32 -04:00
parent 231c893c6b
commit 7e120ae5e9
2 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
project/_Docs.md → project/Readme.md
View File

@ -11,8 +11,8 @@ The files are setup to compile as one unit. As such the source files for Bloat,
Bloat contains some aliasing of some C++ keywords and does not use the standard library. Instead a library called ZPL is used (Single header replacement).
The program has pretty much no optimizations made to it, its just regular loops with no threading.
Just tried to keep the memory at reasonable size of what it does.
The program has pretty much no optimizations made to it, its just regular loops with no threading.
Just tried to keep the memory at a reasonable size for what it does.
The program execution is pretty much outlined quite clearly in `int main()`.
@ -27,7 +27,7 @@ The program execution is pretty much outlined quite clearly in `int main()`.
`*` This technically can be skipped on windows, may be worth doing to reduce latency of process shutdown.
There are constraints of specific sizes of variables;
There are constraints for specific variables;
* `Path_Size_Largest` : Longest path size is set to 1 KB of characters.
* `Token_Max_Length` : Set to 1 KB characters as well.
@ -36,6 +36,6 @@ There are constraints of specific sizes of variables;
The `Path_Size_Largest` and `Token_Max_Length` are compile-time constraints that the runtime will not have a fallback for, if 1 KB is not enough it will need to be changed for your use case.
`Array_Reserve_Num` is used to dictate the assumed amount of tokens will be held in total for any of spec's arrays holding ignores and refactor entries. If any of the array's exceed 4 KB they will grow trigigng a resize which will bog down the speed of the refactor. Adjust if you think you can increase or lower for use case.
`Array_Reserve_Num` is used to dictate the assumed amount of tokens will be held in total for any of spec's arrays holding ignores and refactor entries. If any of the array's exceed 4 KB they will grow triggering a resize which will bog down the speed of the refactor. Adjust if you think you can increase or lower for use case.
Initial Global arena size is a finicy thing, its most likely going to be custom allocator at one point so that it can handle growing properly, right now its just grows if the amount of memory file paths will need for sources is greater than 1 MB.