From d752b57078d7a39579fe035e8b18a0ffc813bd36 Mon Sep 17 00:00:00 2001
From: quan27 <21685516+ntkwan@users.noreply.github.com>
Date: Sun, 7 Jan 2024 00:20:36 +0700
Subject: [PATCH] Add README.md

---
 README.md                   | 47 ++++++++++++++++++++++++++++++++++++-
 external/samples/sample.svg |  2 --
 2 files changed, 46 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b8d43dbb..c6bb555b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,46 @@
-# csc10003-svg-reader
\ No newline at end of file
+# csc10003-svg-reader
+  
+## Features
+
+- Parse SVG files and render them with basic tags (Circle, Rect, Ellipse, etc).
+- Support ViewBox for SVG.
+- Interactivity (Zoom In/Out, Rotate, Dragging).
+- Render group of shapes and their transformations.
+- Render path with most of its tags.
+- Support Radial/Linear gradient for shapes.
+
+## Release
+
+The application only runs on Windows platform. We also supports windows toolchain to run 'virtually' on Linux. However, we don't ensure its perform stably on Linux.
+
+## Demonstration
+[Here is the video demo on Youtube](https://youtu.be/PYpJSK_OGnI?si=Ip6UWNFg1aipduIO)
+
+## Dependencies
+
+### Application
+
+- C++20 (any GNU versions)
+- CMake 3.14
+- [gdiplus](https://github.com/mono/libgdiplus)
+- [rapidxml](https://rapidxml.sourceforge.net)
+
+### Documentation
+
+- [Doxygen](https://www.doxygen.nl/)
+- [PlantUML](https://plantuml.com/)
+- [hpp2plantuml](https://github.com/thibaultmarin/hpp2plantuml)
+
+## Installation
+
+- Clone this repository
+- `cmake -S. -Bbuild` (with `-G "MinGW Makefiles"` if your system is Windows-based)
+- `make -Cbuild` 
+- The executable `svg-reader` in the directory will appear.
+
+
+## Documentation
+
+For the LaTeX version, refer to [`latex/refman.pdf`](https://github.com/ntkwan/csc10003-svg-reader/tree/main/latex).
+
+For the web version, refer to [this webpage](ntkwan.github.io/csc10003-svg-reader/).
diff --git a/external/samples/sample.svg b/external/samples/sample.svg
index f78a17e8..3032f923 100644
--- a/external/samples/sample.svg
+++ b/external/samples/sample.svg
@@ -16,6 +16,4 @@
   <polygon fill="rgb(153, 204, 255)" fill-opacity="0.5" stroke-width="10" stroke="rgb(255, 0, 102)" stroke-opacity="0.7" points="850,75 958,137 958,262 850,325 742,262 742,137" />
   <polygon fill="rgb(255, 255, 0)" fill-opacity="0.6" stroke-width="10" stroke="rgb(255, 0, 0)" stroke-opacity="0.7" points="350,75 379,161 469,161 397,215 423,301 350,250 277,301 303,215 231,161 321,161" />
   <polyline points="0,40 40,40 40,80 80,80 80,120 120,120 120,140" fill-opacity="0.5" />
-  <path fill="none" stroke="rgb(0,0,255)" stroke-width="5" d="M100,200 C100,100 250,100 250,200 C250,300 400,300 400,200" />
-
 </svg>
\ No newline at end of file