Skip to content

Commit c50fc00

Browse files
committedJan 18, 2025
Update source examples
Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
1 parent b40df17 commit c50fc00

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed
 

‎CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ CGL requires the following to get started with development :
122122
- OpenAL (Optional)
123123
- Freetype2 (Optional)
124124

125-
You can check the example CMakeLists.txt file for how to setup a project [here](https://github.com/Jaysmito101/cgl/blob/main/examples/example_cmakelists.txt).
125+
You can check the example CMakeLists.txt file for how to setup a project [here](https://github.com/Jaysmito101/cgl/blob/main/examples/c/example_cmakelists.txt).
126126

127127

128128
### Improving The Documentation
@@ -145,7 +145,7 @@ Before contributing please read through a part of `cgl.h` to get an idea of CGL
145145
- Try to compress the code by
146146
* Avoid braces for single line blocks
147147
* Try to avoid if/else if possible
148-
* Try to compress multiple lines to a single line as much as posible
149-
- Use CGL internal types for new modules rather than creating it seperately for them
150-
- Avoid Code Repetation
148+
* Try to compress multiple lines to a single line as much as possible
149+
- Use CGL internal types for new modules rather than creating it separately for them
150+
- Avoid Code Repetition
151151
- Try to place simple single line functions as Macros if possible

‎README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
8080
- Bower Watson Algorithm for Delaunay Triangulator
8181

8282
* Artificial Intelligence
83-
- Neural Netowrks
83+
- Neural Networks
8484
- Backpropagation
8585
- Serializing/Deserializing networks
8686
- Multi Variable Linear Regression
@@ -91,13 +91,13 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
9191

9292
* Data structures
9393
- List(dynamic array) + Stack (implemented together)
94-
- Hashtable -> This hastable is general purpose. Key can be string or a n-bit buffer. The value can be anything int, string, float, custom types, ...
95-
- Hashtable Iterator -> Iterate through the hashtable using a [simple](https://github.com/Jaysmito101/cgl/blob/main/examples/using_hashtable_iterator.c) API
94+
- Hashtable -> This hashtable is general purpose. Key can be string or a n-bit buffer. The value can be anything int, string, float, custom types, ...
95+
- Hashtable Iterator -> Iterate through the hashtable using a [simple](https://github.com/Jaysmito101/cgl/blob/main/examples/c/using_hashtable_iterator.c) API
9696

9797
* Logger
9898
- Can be enabled/disabled by `#define CGL_DISABLE_LOGGER`
9999
- Log to multiple log files simultaneously
100-
- Log to console with colored output for seperate log levels
100+
- Log to console with colored output for separate log levels
101101
- Logger with auto timestamps
102102

103103
* Cross Platform Networking (Optional)
@@ -106,7 +106,7 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
106106
- SSL sockets (optional) (requires OpenSSL)
107107
- HTTP/HTTPS request (beta)
108108

109-
* General Purpose Markov Chains (Optional) [Example](./examples/markov_text_generation.c)
109+
* General Purpose Markov Chains (Optional) [Example](./examples/c/markov_text_generation.c)
110110
- Can work with any type of data ( text / image / etc. )
111111
- Train/Generate with 3 - 4 lines of code
112112
- Trainer implemented for text generation (n-gram based)
@@ -127,11 +127,11 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
127127

128128
* 2D Collision Detection
129129
- Detect collisions between 2D polygons
130-
- Generate Seperating Axes for polygons
130+
- Generate Separating Axes for polygons
131131
- Get Overlap distance
132132
- GJK (Gilbert–Johnson–Keerthi distance algorithm)
133133
- EPA (Expanding Polytope Algorithm)
134-
- SAT (Seperate Axis Theorem)
134+
- SAT (Separate Axis Theorem)
135135

136136
* Marching Square
137137
- Fully Customizablt Marcher
@@ -190,14 +190,14 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
190190
- Plot a function
191191
- font based text widgets (load custom font for high quality text rendering with widgets api)
192192
- Surrport for rendering 3D meshes with widgets API
193-
- Support for Textures to Widgtes API (efficient)
193+
- Support for Textures to Widgets API (efficient)
194194
- Advanced Bezier Curve( lines or dotted) widget
195195
- Add individual vertices
196196
- Adjust stroke color/thickness
197197
- Customize Batch renderer max vertices capacity (for low memory systems)
198198

199199
* Math library
200-
- Advanced Matrix Library (this is seperate from matrix lib for graphics)
200+
- Advanced Matrix Library (this is separate from matrix lib for graphics)
201201
- Linear Algebra for matrixx math
202202
- vec2/vec3/vec4
203203
- mat3/mat4 (for graphics)

0 commit comments

Comments
 (0)