Updated readme.

LICENSE

@@ -0,0 +1,22 @@
+Copyright 2017-2024 István Csoba
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,7 +1,55 @@
+# OpenLensFlare: an Open-Source, Lens Flare Designing and Rendering Framework
+
 Official repository for the OpenLensFlare framework.
 
-Current limitations:
+## Building
+
+CMake build files are provided for both the editor and runtime components.
+
+### Required third-party libraries
+
+- [Qt 5](https://www.qt.io/) (LensPlanner)
+- [GLEW](https://glew.sourceforge.net/) (LensPlanner, runtime)
+- [glm](https://glm.g-truc.net/) (LensPlanner, runtime)
+
+## Main limitations
+
+    - Only optical systems with one iris are supported.
+    - Only ghosts that cross an aperture once can be simulated.
+    - Only ghosts that are reflected twice are supported.
+
+## Screenshots
+
+The *LensPlanner* editor component in action.
+![Editor](Docs/editor_with_render.png)
+
+An example simulation generated using the OpenLensFlare runtime library in an external framework.
+![Render](Docs/render.png)
+
+## Related publication & citation
+
+- [OpenLensFlare: an Open-Source, Lens Flare Designing and Rendering Framework](https://core.ac.uk/download/pdf/295592402.pdf)
+
+If you find the framework useful, I kindly ask that you cite the paper as follows:
+
+```
+@inproceedings{coba2017openlensflare,
+  author       = {Csoba, István},
+  title        = {{OpenLensFlare: an Open-Source, Lens Flare Designing and Rendering Framework}},
+  booktitle    = {WSCG 2017},
+  booksubtitle = {Short Papers Proceedings},
+  editor       = {Skala, Vaclav},
+  year         = {2017},
+  month        = {06},
+  pages        = {195--203},
+  series       = {Computer Science Research Notes},
+  vol          = {2702},
+  location     = {Plzeň, Czech Republic},
+  organization = {Vaclav Skala--UNION Agency},
+  isbn         = {978-8-086-94350-3}
+}
+```
+
+## License
 
-    - It only supports optical systems with EXACTLY one iris.
-    - Only ghosts that cross an aperture EXACTLY twice are supported.
-    - Only ghosts that are reflected EXACTLY twice are supported.
+This project is licensed under the BSD 2-clause License, see [LICENSE](LICENSE) for more information.