From 4c688c174261fb71d668813eef7156fcadf01d24 Mon Sep 17 00:00:00 2001 From: PlexSheep Date: Sat, 26 Nov 2022 21:53:56 +0100 Subject: [PATCH] README update --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 771d0a4..9e8ebc3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ # c-basic 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**. -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 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. +## 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: `scanf()` is not inherently unsafe, but must be handled very careful and isn't recommended by most, so i have