starred/Memola
1
0
Fork 0
mirror of https://github.com/dscyrescotti/Memola.git synced 2026-01-11 20:00:24 +01:00
Code Issues 5 Packages Projects Releases 3 Wiki Activity

Merge pull request #79 from dscyrescotti/docs/readme-revamp

Browse Source 
Update README and Contributing Guideline
This commit is contained in:
Aye Chan
2024-11-28 22:15:08 +07:00
committed by GitHub
parent 9cf4e6ac10 ae2df33dc3
commit a6a9f48053
2 changed files with 30 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@@ -2,13 +2,23 @@
Be a part of Memola! Pull requests, bug reports, suggestions and any other contributions are welcomed and highly encouraged.
## Fork and Clone
## Table of Contents
- [Getting Start](#getting-started)
- [Contributing](#contributing)
- [Branching](#branching)
- [Pull Request](#pull-request)
- [Feature Request](#feature-request)
- [Bug Report](#bug-report)
- [Community](#community)
- [Code of Conduct](#code-of-conduct)
## Getting Started
Tap the "Fork" button on the top of the site. After forking, clone the forked repository to your Mac.
```bash
git clone https://github.com/dscyrescotti/Memola.git
cd Memola
```
## Run Project
Make sure you have already installed the latest Xcode and open the project.
```bash
xed Memola.xcodeproj
@@ -16,7 +26,7 @@ xed Memola.xcodeproj
Now you are good to run the project and explore the codebase.
> [!IMPORTANT]
> You need to change the bundle identifier and run the project on a real device that supports for Metal.
> You can check Metal compatibility [here](https://support.apple.com/en-us/102894)
> You can check Metal compatibility [here](https://support.apple.com/en-us/102894).
## Contributing
We’re excited to have you contribute and be part of our project’s growth! Whether you’re fixing bugs, implementing new features, or suggesting improvements, your input is invaluable.
@@ -24,8 +34,16 @@ We’re excited to have you contribute and be part of our project’s growth! Wh
- Our list of open bug issues is a great way to contribute and improve the app’s stability. Browse the "Issues" tab to find bugs labeled as “bug” or “help wanted”.
- Feel free to bring your own commits for enhancements—whether it’s a new feature, optimization, or improvement, your input matters!
## Branching
When contributing to Memola, please follow these branching guidelines to ensure smooth collaboration:
- Always create your branches starting from the `develop` branch.
- Use a clear and descriptive name that reflects the purpose of the branch, such as:
- `feature/your-feature-name` for new features.
- `bug/issue-description` for bug fixes.
## Pull Request
Once you are happy with your changes, submit a "Pull Request".
Once you are happy with your changes, submit a "Pull Request" targeting the `develop` branch for review.
The pull request opens with a template loaded. Fill out all fields that are relevant.

10
README.md
View File

@@ -21,12 +21,18 @@ Memola is an open-source note-taking application, fully built using the Metal fr
</p>
## 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.
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 Memola, started to dive into the world of GPU programming.
## Community
We encourage open and constructive discussions within our [GitHub Discussions](https://github.com/dscyrescotti/Memola/discussions) to help improve the project, share ideas, and address challenges together. Whether you’re looking for help, proposing new features, or sharing your insights, our community is here to collaborate and grow.
## Contributing
**Memola** welcomes all developers to contribute if you have any idea to enhance and open an issue if you encounter any bug.
Memola welcomes all developers to contribute! Share your enhancement ideas or report bugs by opening an issue with detailed information. Your input is invaluable to the project’s success!
Before contributing, please review our [Contributing Guideline](/CONTRIBUTING.md) for more information.
## Credits
Memola wouldn’t exist without the incredible work of these repositories.
- [BezierKit](https://github.com/hfutrell/BezierKit)
- [FastDraw](https://github.com/collinzrj/FastDraw)
- [hand-drawing-swift-metal](https://github.com/owengombas/hand-drawing-swift-metal)