docs: update PROJECT_TOUR.md and CONTRIBUTING.md

Author: harshsankhla18

.github/Contributor_Guide/Contributing.md

@@ -1,12 +1,12 @@
-# Contribute to <Project_Name>
+# Contribute to <Image-Filtering>
 
-Thank you for taking the time to contribute to <project_name>! We really appreciate it. 
+Thank you for taking the time to contribute to <Image-Filtering>! We really appreciate it. 
 
 Before contributing, please make sure to read the [Code of Conduct](../../CODE_OF_CONDUCT.md). We expect you to follow it in all your interactions with the project.
 
-## New to <Project_Name>?
+## New to <Image-Filtering>?
 
-If you are new to <Project_Name>, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
+If you are new to <Image-Filtering>, please take a look at the [documentation](./Project_Tour.md). It is a great place to start.
 
 ## New Contributor Guide
 
@@ -22,13 +22,13 @@ If you find a bug in the source code, you can help us by [submitting an issue](.
 
 ### Suggesting Enhancements
 
-If you want to suggest an enhancement to <Project_Name>, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
+If you want to suggest an enhancement to <Image-Filtering>, please [submit an issue](../ISSUE_TEMPLATE/feature_request.yaml).
 
 ### Pull Requests
 
-If you want to contribute to <Project_Name>, submit a pull request.
+If you want to contribute to <Image-Filtering>, submit a pull request.
 
-- url: `https://github.com/OPCODE-Open-Spring-Fest/<project_Name>/compare/branch...YOURGITHUBUSERNAME:<project_Name>:BRANCH?quick_pull=1&template=pr.md`
+- url: `https://github.com/OPCODE-Open-Spring-Fest/<Image-Filtering>/compare/branch...YOURGITHUBUSERNAME:<Image-Filtering>:BRANCH?quick_pull=1&template=pr.md`
 
 ### Requirements
 

.github/Contributor_Guide/Project_Tour.md

@@ -1,12 +1,65 @@
 # Project Tour
 
-* notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
-
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+## Understanding Files
+
+### bmp.h
+
+Open up bmp.h (as by double-clicking on it in the file browser) and have a look.
+
+You’ll see definitions of the headers we’ve mentioned (BITMAPINFOHEADER and BITMAPFILEHEADER). In addition, that file defines BYTE, DWORD, LONG, and WORD, data types normally found in the world of Windows programming. Notice how they’re just aliases for primitives with which you are (hopefully) already familiar. It appears that BITMAPFILEHEADER and BITMAPINFOHEADER make use of these types.
+
+Perhaps most importantly for you, this file also defines a struct called RGBTRIPLE that, quite simply, “encapsulates” three bytes: one blue, one green, and one red (the order, recall, in which we expect to find RGB triples actually on disk).
+
+Why are these structs useful? Well, recall that a file is just a sequence of bytes (or, ultimately, bits) on disk. But those bytes are generally ordered in such a way that the first few represent something, the next few represent something else, and so on. “File formats” exist because the world has standardized what bytes mean what. Now, we could just read a file from disk into RAM as one big array of bytes. And we could just remember that the byte at array[i] represents one thing, while the byte at array[j] represents another. But why not give some of those bytes names so that we can retrieve them from memory more easily? That’s precisely what the structs in bmp.h allow us to do. Rather than think of some file as one long sequence of bytes, we can instead think of it as a sequence of structs.
+
+
+### filter.c
+
+Now, let’s open up filter.c. This file has been written already for you, but there are a couple important points worth noting here.
+
+First, notice the definition of filters on line 10. That string tells the program what the allowable command-line arguments to the program are: b, g, r, and s. Each of them specifies a different filter that we might apply to our images: blur, grayscale, reflection, and sepia.
+
+The next several lines open up an image file, make sure it’s indeed a BMP file, and read all of the pixel information into a 2D array called image.
+
+Scroll down to the switch statement that begins on line 101. Notice that, depending on what filter we’ve chosen, a different function is called: if the user chooses filter b, the program calls the blur function; if g, then grayscale is called; if r, then reflect is called; and if s, then sepia is called. Notice, too, that each of these functions take as arguments the height of the image, the width of the image, and the 2D array of pixels.
+
+These are the functions you’ll (soon!) implement. As you might imagine, the goal is for each of these functions to edit the 2D array of pixels in such a way that the desired filter is applied to the image.
+
+The remaining lines of the program take the resulting image and write them out to a new image file.
+
+
+### Helpers.h
+
+Next, take a look at helpers.h. This file is quite short, and just provides the function prototypes for the functions you saw earlier.
+
+Here, take note of the fact that each function takes a 2D array called image as an argument, where image is an array of height many rows, and each row is itself another array of width many RGBTRIPLEs. So if image represents the whole picture, then image[0] represents the first row, and image[0][0] represents the pixel in the upper-left corner of the image
+
+
+### Helpers.c
+
+Now, open up helpers.c. Here’s where the implementation of the functions declared in helpers.h belong. But note that, right now, the implementations are missing! This part is up to you.
+
+
+### Compile
+Paste This in you Terminal(without quotes):
+
+    "gcc -g -std=c11 -Wall -Wextra -Wshadow filter.c helpers.c -o filter -lm"
+
+
+### Run 
+Paste This in you Terminal(without quotes)
+1. For grayscale:
+ 
+       "filter -g in.bmp out.bmp" 
+
+2. For blur:
+
+       "filter -b in.bmp out.bmp" 
+
+3. For reflect:
+
+       "filter -r in.bmp out.bmp" 
+
+4. For sepia:
+
+       "filter -s in.bmp out.bmp"