docs: add readme

This commit is contained in:
dscyrescotti
2024-11-15 14:10:15 +07:00
parent 038c62f1be
commit d306e5c333
3 changed files with 33 additions and 2 deletions

BIN
Assets/app-demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.0 MiB

BIN
Assets/app-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

View File

@@ -1,3 +1,34 @@
# 📝 Memola
<p align="center">
<img width="30%" src="Assets/app-logo.png">
</p>
Memola is an application where you capture your thoughts, concepts, notes and moods.
<hr/>
**Memola** is an open-source note-taking application that lets you jot down ideas and sketch your visions seamlessly on your iPhone, iPad, and MacBook.
<p align="center">
<img width="100%" src="Assets/app-demo.png">
</p>
## 🎉 Motivation
Last year, I started reading Metal by Tutorials from Kodeco and was fascinated by GPU programming, particularly the process of building a graphic rendering engine. This led me to develop a note-taking app with a 2D render engine using Metal. There were a lot of challenges throughout, and I initially thought it would be a flop. However, I managed to figure out workarounds to get a functional render engine. I know it is not perfect yet and there are a lot of battles to be won in optimizing render efficiency and adding more writing tools. Regardless, I feel like it is ready to lauch the app and make the code open-source.
## 👨‍💻 Contributions
**Memola** welcomes all developers to contribute if you have any idea to enhance and open an issue if you encounter any bug.
## 🙇 Credits
- [BezierKit](https://github.com/hfutrell/BezierKit)
- [FastDraw](https://github.com/collinzrj/FastDraw)
- [hand-drawing-swift-metal](https://github.com/owengombas/hand-drawing-swift-metal)
- [ios_metal_bezier_renderer](https://github.com/eldade/ios_metal_bezier_renderer)
- [MaLiang](https://github.com/Harley-xk/MaLiang)
- [MetalPaint](https://github.com/rydermackay/MetalPaint)
- [MetalScroller](https://github.com/chunkyguy/MetalScroller)
- [Metal2DScrollable](https://github.com/codelynx/Metal2DScrollable)
- [rbush](https://github.com/mourner/rbush)
- [RTree](https://github.com/imbcmdth/RTree)
- [Sketch](https://github.com/daihase/Sketch)
- [THST](https://github.com/tuxalin/THST)
## © License
**Memola** is available under the MIT license. See the [LICENSE](/LICENSE) file for more info.