Skip to content

Commit

Permalink
Documentation Update
Browse files Browse the repository at this point in the history
Additionally added clear instructions of the installation.

Table of Contents
Introduction about the software
Software own information
Examples
Prerequisites
 - Font
 - Libraries
  • Loading branch information
VerzatileDev authored Sep 9, 2023
1 parent 3c3a823 commit 332ccbf
Showing 1 changed file with 103 additions and 11 deletions.
114 changes: 103 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,37 @@
# C Image Processing
# Table of Contents

* [Introduction](#introduction)
* [Software Information](#software-information)
* [Examples](#examples)
* [Contribution](#contribution)
* [Installation](#installation)
* [Cloning via Terminal](#cloning-via-terminal)
* [Cloning via GitHub Desktop](#cloning-via-github-desktop)
* [Prerequisites](#prerequisites)
* [Project Requirements](#project-requirements)
* [Fonts](#fonts)
* [License](#license)

</br>

# Introduction


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.

</br>

### Software Information

* Developed with " C " Programming Language
* Development Setup and Wiki built for Visual Studio Code
* Uses Libraries such as " GTK4 ", " JpegLib ", "PngLib ", Additional added in the future.

</br>

### Examples

</br>

<p align="center">
<img src="readme_images/readme_image_0.png" width="200" height="300"/>
Expand All @@ -11,24 +44,83 @@
<img src="readme_images/readme_image_7.png" width="200" height="300"/>
</p>

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.
</br>

## Contribution

To contribute to `c_image_processing`, please follow these steps:

1. Fork the repository to your own account.
2. Create a feature branch for your contributions.
3. Make your desired changes and commit them to your feature branch.
4. Read the comprehensive setup documentation available in the repository's wiki.
5. Submit a pull request from your feature branch to the main repository.


We appreciate your contributions and look forward to reviewing your pull request

</br>

# Fonts

The fonts used in this program, are available here:
## Installation

<a href="https://www.dafont.com/bignoodletitling.font">
### Cloning via Terminal:

```bash

Open your terminal and navigate to the directory where you want to clone the repository
cd /desired/directory

Clone the repository
git clone https://github.com/VerzatileDevOrg/C_image_processing

Move into the cloned directory
cd C_image_processing

```

### Cloning via GitHub Desktop:

1. Open GitHub Desktop and ensure you're logged in to your GitHub account.
2. Click on the "+" button in the top left corner and select "Clone Repository".
3. In the "Clone a Repository" window, select the "URL" tab.
4. Paste the repository URL: https://github.com/VerzatileDevOrg/C_image_processing.
5. Choose a local path for the repository.
6. Click on "Clone Repository" to complete the process.

This will clone the repository to your local machine, allowing you to work with the codebase.

</br>

## Prerequisites

### Project Requirements:

1. Visual studio Code.
2. `Windows 10` or Newer.
3. Installation of `C` Language.
4. Setup of GTK4, Jpeg, Png Libraries.

</br>

### Fonts

The typefaces employed in this program can be obtained from the following source:

* <a href="https://www.dafont.com/bignoodletitling.font">
Big Noodle Titling
</a>

# Contribution
</br>

## License

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

# Installing
Copyright (c) 2023 VerzatileDevOrg (Sommos / Verzatildev )

Clone the repo:
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:

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

cd c_image_processing
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 comments on commit 332ccbf

Please sign in to comment.