docs: README.md
Browse files- .gitignore +1 -1
- README.md +3 -0
.gitignore
CHANGED
|
@@ -159,4 +159,4 @@ cython_debug/
|
|
| 159 |
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
| 160 |
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
| 161 |
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
| 162 |
-
|
|
|
|
| 159 |
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
| 160 |
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
| 161 |
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
| 162 |
+
.idea/
|
README.md
CHANGED
|
@@ -14,6 +14,9 @@ src/
|
|
| 14 |
βββ utils/ # Helper functions and utilities
|
| 15 |
tests/
|
| 16 |
βββ integration/ # Integration tests
|
|
|
|
|
|
|
|
|
|
| 17 |
```
|
| 18 |
|
| 19 |
### Key Components
|
|
|
|
| 14 |
βββ utils/ # Helper functions and utilities
|
| 15 |
tests/
|
| 16 |
βββ integration/ # Integration tests
|
| 17 |
+
.gitignore # Git ignore file
|
| 18 |
+
README.md # Project documentation
|
| 19 |
+
requirements.txt # Dependencies
|
| 20 |
```
|
| 21 |
|
| 22 |
### Key Components
|