From 0fe1cbf8004210a9fbd8778ad0d5722baaca90d8 Mon Sep 17 00:00:00 2001 From: DrewTechs Date: Sat, 12 Mar 2022 03:04:32 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef279f1..8049324 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,17 @@ # Notebinder -The Note Binder is a Note Organizing Application with a built-in Application Launcher to compliment Note Taking applications. \ No newline at end of file +The Note Binder is a Note Organizing Application with a built-in Application Launcher to compliment Note Taking applications. + +This is currently at Version 1.0 + +# Compiling the program: + +To compile the program, installing the required dependencies is essential. Installing qt5-base and qt5-default is recommended as well as setting up qmake. Also install build essentials such as make, gcc/g++ as well. + +Once dependencies are installed run qmake and a Makefile will be generated. + +Then run make -j N where N is the number of jobs runnning on the CPU (highest recommended number being the same number of CPU threads on the computer compiling the code). + +Once that is runned the application has been created (the binary file is NoteBinder). + +More information on this project can be found at https://drewtechs.net/projects/note-binder \ No newline at end of file