Improve sample documentation with header updates

Author: ArjArav98

README.md

@@ -18,7 +18,7 @@ A C++17-compatible header that provides useful functions which help with the sol
 ## Usage 
 
 * Simply download the `src/sudoku_suite.h` file and move it to your project's directory.
-* Include the header file, as shown below in the examples, and use the functions you need!
+* Include the required header files, as shown below in the examples, and use the functions you need!
 * **NOTE:** The code is incompatible with pre-C++17 versions. While compiling, you'll have to compile with the `--std=c++17` flag.
     * For example; when using the clang compiler, the compile command would be `c++ --std=c++17 /path/to/file.cpp`
 
@@ -51,7 +51,8 @@ There are **three functions** that Sudoku-Suite provides the developer, along wi
 #### Solving and validating Sudoku puzzle
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/sudoku_solver.h"
+#include"/path/to/src/sudoku_validator.h"
 
 int main() {
     sudoku::Grid grid({{
@@ -80,7 +81,7 @@ int main() {
 #### Generating a Sudoku puzzle 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/sudoku_generator.h"
 
 int main() {
     sudoku::Grid grid = sudoku::generate_puzzle();
@@ -93,7 +94,10 @@ int main() {
 #### Initialising and reusing Grid objects 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     //================
@@ -162,7 +166,10 @@ File: `sample1.txt`
 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
     sudoku::Grid grid;
@@ -179,7 +186,10 @@ int main() {
 #### Operations on Grid objects 
 ```
 #include<iostream>
-#include"/path/to/sudoku_suite.h"
+#include"/path/to/src/grid.h"
+
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
 
 int main() {
 

samples/initialising_grid_from_file.cpp

@@ -1,9 +1,12 @@
 /* Copyright 2023 Arjun Aravind */
-/* A basic example. */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
 #include"../src/sudoku_solver.h"
 
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
+
 int main() {
     sudoku::Grid grid;
     grid.set_initial_state_from_file("samples/sample1.txt");

samples/initialising_grids.cpp

@@ -1,9 +1,12 @@
 /* Copyright 2023 Arjun Aravind */
-/* A basic example. */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
 #include"../src/grid.h"
 
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
+
 int main() {
     // Method 1: Use the constructor and pass in a
     // 2D matrix of values.

samples/operations_on_grid_objects.cpp

@@ -1,9 +1,12 @@
 /* Copyright 2023 Arjun Aravind */
-/* A basic example. */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
 #include"../src/grid.h"
 
+/* NOTE: If you only need to utilise the Grid object,
+ * you can just import the "grid.h" header alone. */
+
 int main() {
     sudoku::Grid sample_grid_1({{
         {{ 1, 7, 2, 5, 4, 9, 6, 8, 3 }},

samples/sudoku_generator.cpp

@@ -1,5 +1,5 @@
 /* Copyright 2023 Arjun Aravind */
-/* A basic example. */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
 #include"../src/sudoku_generator.h"

samples/sudoku_solver.cpp

@@ -1,5 +1,5 @@
 /* Copyright 2023 Arjun Aravind */
-/* A basic example. */
+/* A basic example as seen in the project's README. */
 
 #include<iostream>
 #include"../src/sudoku_solver.h"