updated doc

muiz6 · Jul 3, 2024 · 08115aa · 08115aa
1 parent 830f605
commit 08115aa
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 7 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -1,17 +1,29 @@
-> Our Semester Project for OOP
-
 # CIMP
-## Introduction
-CIMP is an image manipulation program that can apply filters to an image.
 
-![logo](/media/icon.png)
+CIMP is an image manipulation program written in C++. All features are developed from scratch (other
+than the GUI which uses with WxWidgets library for graphical components).
+
+![logo](/docs/icon.png)
+
+### Features
+
+- Open sevaral bitmap image formats
+- Save as servaral bitmap image formats (including a quantised 8-bit bmp format)
+- Apply colour filters such as alienate, invert colours, sepia & more
+- Vertically invert the image
+- Graphical User Interface
 
 ### Dependencies
+
 CIMP depends upon [wxWidgets](https://github.com/wxWidgets/wxWidgets). Library for its
 Graphic User Interface. Do add it in your project prior to compilation.
 
 ### Screenshots
 
-![original image](/media/sc1.jpg)
+![original image](/docs/sepia.jpg)
+
+![alienate filter](/docs/alienate.jpg)
+
+When image is saved as 8-bit bitmap it is quantised to have fewer than 256 colours:
 
-![alienate filter](/media/sc2.jpg)
+![quantisation filter](/docs/quantisation.jpg)
diff --git a/docs/alienate.jpg b/docs/alienate.jpg
diff --git a/media/icon.png → docs/icon.png b/media/icon.png → docs/icon.png
diff --git a/docs/quantisation.jpg b/docs/quantisation.jpg
diff --git a/docs/sepia.jpg b/docs/sepia.jpg
diff --git a/media/sc1.jpg b/media/sc1.jpg
diff --git a/media/sc2.jpg b/media/sc2.jpg