README update

This commit is contained in:
Christoph J. Scherr 2022-11-26 21:53:56 +01:00
parent d6f9795ecb
commit 4c688c1742
1 changed files with 7 additions and 2 deletions

View File

@ -1,14 +1,19 @@
# c-basic # c-basic
This Repository features C source code i wrote to learn the C programming language. Currently the most advanced program included is an This Repository features C source code i wrote to learn the C programming language. Currently the most advanced program included is an
unfinished implementation of the huffman algorithm. unfinished implementation of the Huffman algorithm.
Some programs make use of outdated and unsafe functions such as `gets()` or `scanf()`, which **should never be used**. Some programs make use of outdated and unsafe functions such as `gets()` or `scanf()`, which **should never be used**.
That is the case, because we were teached to use some of these in programming classes. Ideally, all uses That is the case, because we were taught to use some of these in programming classes. Ideally, all uses
of these unsafe functions should include a comment explaining why this is bad and also include and implemented of these unsafe functions should include a comment explaining why this is bad and also include and implemented
alternative, but that may not always be the case. alternative, but that may not always be the case.
All code in this Repository was written on and for a Linux x86_64 system. It might not work on other systems. All code in this Repository was written on and for a Linux x86_64 system. It might not work on other systems.
## Makefile / Compiling
I have spent some time building a makefile. You can compile all source code using `make`.
This will also generate some smaller testfiles for use with the Huffman implementation. In case you want to
try Huffman with some bigger files, you can make your own or do `make big` to autogenerate the bigger files aswell.
### Note: ### Note:
`scanf()` is not inherently unsafe, but must be handled very careful and isn't recommended by most, so i have `scanf()` is not inherently unsafe, but must be handled very careful and isn't recommended by most, so i have