Skip to content

Commit 332ccbf

Browse files
authored
Documentation Update
Additionally added clear instructions of the installation. Table of Contents Introduction about the software Software own information Examples Prerequisites - Font - Libraries
1 parent 3c3a823 commit 332ccbf

File tree

1 file changed

+103
-11
lines changed

1 file changed

+103
-11
lines changed

README.md

Lines changed: 103 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
1-
# C Image Processing
1+
# Table of Contents
2+
3+
* [Introduction](#introduction)
4+
* [Software Information](#software-information)
5+
* [Examples](#examples)
6+
* [Contribution](#contribution)
7+
* [Installation](#installation)
8+
* [Cloning via Terminal](#cloning-via-terminal)
9+
* [Cloning via GitHub Desktop](#cloning-via-github-desktop)
10+
* [Prerequisites](#prerequisites)
11+
* [Project Requirements](#project-requirements)
12+
* [Fonts](#fonts)
13+
* [License](#license)
14+
15+
</br>
16+
17+
# Introduction
18+
19+
20+
This initiative aims to develop an extensive and robust library of image processing functions, implemented in the C programming language. The ultimate objective is to establish a versatile platform capable of ingesting PPM images, executing a range of filters and transformations, and subsequently generating a modified image file. It is important to note that this project is currently in active development, with ongoing efforts to enhance its capabilities.
21+
22+
</br>
23+
24+
### Software Information
25+
26+
* Developed with " C " Programming Language
27+
* Development Setup and Wiki built for Visual Studio Code
28+
* Uses Libraries such as " GTK4 ", " JpegLib ", "PngLib ", Additional added in the future.
29+
30+
</br>
31+
32+
### Examples
33+
34+
</br>
235

336
<p align="center">
437
<img src="readme_images/readme_image_0.png" width="200" height="300"/>
@@ -11,24 +44,83 @@
1144
<img src="readme_images/readme_image_7.png" width="200" height="300"/>
1245
</p>
1346

14-
This program is to builds a simple library of image processing functions in C. The library is then used to create a program that can read in a PPM image, apply a filter to it, and then write the modified image to a new file.
47+
</br>
48+
49+
## Contribution
50+
51+
To contribute to `c_image_processing`, please follow these steps:
52+
53+
1. Fork the repository to your own account.
54+
2. Create a feature branch for your contributions.
55+
3. Make your desired changes and commit them to your feature branch.
56+
4. Read the comprehensive setup documentation available in the repository's wiki.
57+
5. Submit a pull request from your feature branch to the main repository.
58+
59+
60+
We appreciate your contributions and look forward to reviewing your pull request
61+
62+
</br>
1563

16-
# Fonts
1764

18-
The fonts used in this program, are available here:
65+
## Installation
1966

20-
<a href="https://www.dafont.com/bignoodletitling.font">
67+
### Cloning via Terminal:
68+
69+
```bash
70+
71+
Open your terminal and navigate to the directory where you want to clone the repository
72+
cd /desired/directory
73+
74+
Clone the repository
75+
git clone https://github.com/VerzatileDevOrg/C_image_processing
76+
77+
Move into the cloned directory
78+
cd C_image_processing
79+
80+
```
81+
82+
### Cloning via GitHub Desktop:
83+
84+
1. Open GitHub Desktop and ensure you're logged in to your GitHub account.
85+
2. Click on the "+" button in the top left corner and select "Clone Repository".
86+
3. In the "Clone a Repository" window, select the "URL" tab.
87+
4. Paste the repository URL: https://github.com/VerzatileDevOrg/C_image_processing.
88+
5. Choose a local path for the repository.
89+
6. Click on "Clone Repository" to complete the process.
90+
91+
This will clone the repository to your local machine, allowing you to work with the codebase.
92+
93+
</br>
94+
95+
## Prerequisites
96+
97+
### Project Requirements:
98+
99+
1. Visual studio Code.
100+
2. `Windows 10` or Newer.
101+
3. Installation of `C` Language.
102+
4. Setup of GTK4, Jpeg, Png Libraries.
103+
104+
</br>
105+
106+
### Fonts
107+
108+
The typefaces employed in this program can be obtained from the following source:
109+
110+
* <a href="https://www.dafont.com/bignoodletitling.font">
21111
Big Noodle Titling
22112
</a>
23113

24-
# Contribution
114+
</br>
115+
116+
## License
25117

26-
If you'd like to contribute to `c_image_processing` please submit a pull-request on a feature branch.
118+
MIT License
27119

28-
# Installing
120+
Copyright (c) 2023 VerzatileDevOrg (Sommos / Verzatildev )
29121

30-
Clone the repo:
122+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
31123

32-
git clone https://github.com/VerzatileDevOrg/C_image_processing
124+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
33125

34-
cd c_image_processing
126+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)