From a51f9ae83c1d3feb97e54de00b15945088ad5620 Mon Sep 17 00:00:00 2001 From: dscyrescotti Date: Thu, 28 Nov 2024 15:21:13 +0700 Subject: [PATCH 1/3] docs: add motivation --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b4b1592..38f3191 100644 --- a/README.md +++ b/README.md @@ -5,25 +5,28 @@
- + - +

-**Memola** is an open-source note-taking application, fully built using the Metal framework, allowing you to seamlessly jot down ideas and sketch your visions across iOS, iPadOS, and macOS. +Memola is an open-source note-taking application, fully built using the Metal framework, allowing you to seamlessly jot down ideas and sketch your visions across iOS, iPadOS, and macOS.

-## 👨‍💻 Contributions +## Motivation +Metal is a fascinating framework where we can leverage the optimal power of GPUs through compute shaders and rendering shaders to build advanced applications powered by GPUs. This raised multiple questions like "How is the render pipeline constructed?" and "How are renders generated?", which led to an adventurous journey of crafting a 2D render engine. That's how this project, Memola, started to dive into the world of GPU programming. + +## Contributing **Memola** welcomes all developers to contribute if you have any idea to enhance and open an issue if you encounter any bug. -## 🙇 Credits +## 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) @@ -37,5 +40,5 @@ - [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. \ No newline at end of file +## License +Memola is available under the MIT license. See the [LICENSE](/LICENSE) file for more info. \ No newline at end of file From 1e1f8b404908562fe0733bf629ed0267949a6d66 Mon Sep 17 00:00:00 2001 From: dscyrescotti Date: Thu, 28 Nov 2024 21:07:25 +0700 Subject: [PATCH 2/3] chore: add pull request template --- .github/pull_request_template.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..878c586 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ + + +### Description + + + +### Related Issues + + + + + +* #ISSUE_NUMBER + +### Checklist + + + +- [ ] I read and understood the [contributing guide](https://github.com/dscyrescotti/Memola/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/dscyrescotti/Memola/blob/main/CODE_OF_CONDUCT.md) +- [ ] The issues this PR addresses are related to each other +- [ ] My changes generate no new warnings +- [ ] My code builds and runs on my machine +- [ ] My changes are all related to the related issue above + +### Screenshots + + + + \ No newline at end of file From ccbf1016d1f874f5f1d301a3e879ae2b5e1ee980 Mon Sep 17 00:00:00 2001 From: dscyrescotti Date: Thu, 28 Nov 2024 21:19:01 +0700 Subject: [PATCH 3/3] chore: update template --- .github/ISSUE_TEMPLATE/bug-report.md | 28 ++++++++++++----------- .github/ISSUE_TEMPLATE/feature-request.md | 16 ++++++------- .github/pull_request_template.md | 2 -- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 00467d6..b72364b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,26 +7,28 @@ assignees: '' --- -**Description** -A clear and concise description of what the bug is. +### Description + -**Steps to reproduce** +### Steps to reproduce + -**Expected behavior** -A clear and concise description of what you expected to happen. +### Expected behavior + -**Screenshots** -If applicable, add screenshots to help explain your problem. +### Screenshots + -**Device (please complete the following information):** - - OS: [e.g. iOS] - - Model: [e.g. iPhone13] - - Version [e.g. v1.0.1] +### Device (please complete the following information) + - OS: + - Model: + - Version -**Additional context** -Add any other context about the problem here. +### Additional context + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index fd1a812..48311c4 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,14 +7,14 @@ assignees: '' --- -**Backstory** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +### Backstory + -**Proposal** -A clear and concise description of what you want to happen. +### Proposal + -**Alternative** -A clear and concise description of any alternative solutions or features you've considered. +### Alternative + -**Addition** -Add any other context or screenshots about the feature request here, if applicable. +### Addition Context + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 878c586..bafbafc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,3 @@ - - ### Description