Skip to content

Commit 3c91f7c

Browse files
committed
Add notes about modularity
1 parent 2c6ecbb commit 3c91f7c

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ comparison to other modern programming languages. This is a collection of
55
common computer science data structures and algorithms which may be used in C
66
projects.
77

8+
The project is structured in a modular way, such that it is possible to
9+
trivially copy any module (pair of `.c` and `.h` files) into a project without
10+
dealing with the usual hassle of library dependencies. However, the project
11+
does also build as a library named `libcalg` if that's what you want.
12+
813
The code is licensed under the [ISC license](COPYING.md), a permissive license
914
that is functionally identical to the MIT or BSD licenses. As such, it may
1015
legitimately be reused in any project, whether proprietary or open source.

STYLE.md

+7
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,10 @@ All public interfaces must be documented using
7272
*/
7373
unsigned int hash_table_num_entries(HashTable *hash_table);
7474
```
75+
76+
## Modularity
77+
78+
The project is structured in a modular way, such that each module (`.c` and
79+
`.h` file) is independent of the others. The idea is that anyone should be able
80+
to use any file in an "off the shelf" way by trivially copying those two files
81+
into their project.

0 commit comments

Comments
 (0)