diff --git a/README.md b/README.md index 148d5f7..93ea060 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# clui -simple cross-platform library for doing terminal things. +# Clui +Simple cross-platform library for doing terminal things. To learn more about functions, view `sample1.c` or `sample2.c` -## how to run -1. install mingw/gcc on your system and add that to path -2. open a terminal and change directory to clui folder -3. compile `c` code with `gcc sample1.c` or maybe you want to enable warning and debug mode: `gcc -Wall -Wextra -g sample1.c` -4. compile `cpp` code with `g++ your_code.cpp` +## How to run +1. Install Mingw/GCC on your system and add that to the path +2. Open a terminal and change the directory to clui folder +3. Compile `c` code with `gcc sample1.c` or maybe you want to enable warning and debug mode: `gcc -Wall -Wextra -g sample1.c` +4. Compile `cpp` code with `g++ your_code.cpp` -### library and sample codes are tested windows (mingw) and unix (gcc,clang) with both C & C++ codes. +### library and sample codes are tested in Windows (MinGW) and Unix (GCC, clang) with C & C++ codes.