You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,7 @@ CGL requires the following to get started with development :
122
122
- OpenAL (Optional)
123
123
- Freetype2 (Optional)
124
124
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).
126
126
127
127
128
128
### Improving The Documentation
@@ -145,7 +145,7 @@ Before contributing please read through a part of `cgl.h` to get an idea of CGL
145
145
- Try to compress the code by
146
146
* Avoid braces for single line blocks
147
147
* 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
151
151
- Try to place simple single line functions as Macros if possible
- 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
96
96
97
97
* Logger
98
98
- Can be enabled/disabled by `#define CGL_DISABLE_LOGGER`
99
99
- 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
101
101
- Logger with auto timestamps
102
102
103
103
* Cross Platform Networking (Optional)
@@ -106,7 +106,7 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
106
106
- SSL sockets (optional) (requires OpenSSL)
107
107
- HTTP/HTTPS request (beta)
108
108
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)
110
110
- Can work with any type of data ( text / image / etc. )
111
111
- Train/Generate with 3 - 4 lines of code
112
112
- Trainer implemented for text generation (n-gram based)
@@ -127,11 +127,11 @@ CGL (C Graphics Library) is a multipurpose library mainly for recreational codin
0 commit comments