Merge pull request #56 from jvdcf/add_disclaimer

disclaimer

Author: jvdcf

docs/docs.md

@@ -8,7 +8,7 @@ This project was carried out by students from group 23: Duarte Souto Assunção,
 The project was developed in C++ and uses the CMake tool to compile the source code and this documentation.
 ### Using the terminal
 ```
-cmake CMakeLists.txt
+cmake -DCMAKE_BUILD_TYPE=Release CMakeLists.txt
 make
 ./AED2324_PRJ1_G23 -cpu classes_per_uc.csv -c classes.csv -sc students_classes.csv
 ```
@@ -104,4 +104,5 @@ Some requests may be accepted, rejected or cause conflicts, depending on the cur
 # Notes
 - Unfortunately, the maximum capacity of a class is hard coded to 30 students.
 - The terminal embedded in CLion can behave a bit differently than the system's terminal.
-  If possible, use the system's terminal to run the program.
+  If possible, use the system's terminal to run the program.
+- This program is tested for Linux only. As such, it only takes Linux-compatible CSV files on Linux. It might work on Windows, but that is untested.

main.cpp

@@ -24,7 +24,8 @@ int main(int argc, char** argv) {
       << "    schdulEd -cpu classes_per_uc.csv -c classes.csv -sc students_classes.csv\n\n"
       << "Where '-cpu' is the flag that specifies a CSV file which contains the list of classes per each UC\n"
       << "Where '-c' is the flag that specifies a CSV file which contains the list of classes an their schedules\n"
-      << "Where '-sc' is the flag that specifies a CSV file which contains the list of students and their association with each class\n"
+      << "Where '-sc' is the flag that specifies a CSV file which contains the list of students and their association with each class\n\n"
+      << "DISCLAIMER: This program is tested for Linux only. As such, it only takes Linux-compatible CSV files on Linux. It might work on Windows, but that is untested.\n"
       << std::endl;
     std::exit(1);
   }
@@ -56,7 +57,8 @@ int main(int argc, char** argv) {
                 << "    schdulEd -cpu classes_per_uc.csv -c classes.csv -sc students_classes.csv\n\n"
                 << "Where '-cpu' is the flag that specifies a CSV file which contains the list of classes per each UC\n"
                 << "Where '-c' is the flag that specifies a CSV file which contains the list of classes an their schedules\n"
-                << "Where '-sc' is the flag that specifies a CSV file which contains the list of students and their association with each class\n"
+                << "Where '-sc' is the flag that specifies a CSV file which contains the list of students and their association with each class\n\n"
+                << "DISCLAIMER: This program is tested for Linux only. As such, it only takes Linux-compatible CSV files on Linux. It might work on Windows, but that is untested.\n"
                 << std::endl;
       std::exit(1);
   }