Skip to content

Commit 950d0eb

Browse files
IogaMasterIogaMaster
committed
docs: init
1 parent dfba95e commit 950d0eb

File tree

16 files changed

+1275
-4
lines changed

16 files changed

+1275
-4
lines changed

‎.github/FUNDING.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# These are supported funding model platforms
2+
3+
github:
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: iogamaster
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12+
polar: # Replace with a single Polar username
13+
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report
4+
title: ''
5+
labels: bug
6+
assignees: IogaMaster
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Other issue
4+
title: ''
5+
labels: ''
6+
assignees: IogaMaster
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: IogaMaster
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Description of changes
2+
3+
<!-- What changes did you make -->
4+
5+
## Relevant Issues
6+
7+
<!-- Eg. #43 -->
8+
9+
## CC Maintainers
10+
11+
<!-- Most of the time it will be IogaMaster -->
12+

‎.github/workflows/deploy.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy Loom mdBook
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- name: Install Nix
24+
uses: cachix/install-nix-action@v27
25+
26+
- name: Build site
27+
run: nix build .#book
28+
29+
- name: Upload Pages artifact
30+
uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: ./result
33+
34+
deploy:
35+
runs-on: ubuntu-latest
36+
needs: build
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
steps:
41+
- name: Deploy to GitHub Pages
42+
id: deployment
43+
uses: actions/deploy-pages@v4

‎CONTRIBUTING.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to loom
2+
3+
This document is mainly intended for people who want to contribute to loom.
4+
As a short reminder, this is generally what you would need to do:
5+
6+
1. Fork and clone the repository
7+
2. Either stay on the `main` branch, or create a new branch for your feature `[feat|fix|...]/<name>`.
8+
If you are working on multiple PRs at the same time, you should create new branches.
9+
3. Run `nix develop`.
10+
4. Read the chapter below and implement your changes
11+
5. Once finished, create a commit, push your changes and submit a PR.
12+
13+
## Requirements for submitted changes
14+
15+
If you want to submit a change, please make sure you have checked the following things:
16+
17+
- All checks must pass. You can run them with `nix flake check`, which will also check formatting.
18+
- This repository follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style.
19+
So each commit in your PR should contain only one logical change and the commit message
20+
should reflect that accordingly.
21+
22+
Example: If your PR changes two modules, you should also have two commits:
23+
- `feat(modules/loom_log): fix longstanding issue`
24+
- `feat(modules/loom_debugger): new version`
25+
26+
Changes to modules should be scoped like `feat(modules/<module_name>)`,
27+
If a change doesn't fit any of these scopes, then just don't add a scope.

‎LICENSE‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
MIT License
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice (including the next
11+
paragraph) shall be included in all copies or substantial portions of the
12+
Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
17+
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19+
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20+

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<h1 align="center">
2+
<img src="https://raw.githubusercontent.com/IogaMaster/loom/main/docs/loom_engine_logo.png" width="600px"/>
3+
</h1>
4+
5+
<h1 align="center">
6+
<a href='#'><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="600px"/></a>
7+
<br> <br>
8+
<div>
9+
<a href="https://github.com/IogaMaster/loom/issues">
10+
<img src="https://img.shields.io/github/issues/IogaMaster/loom?color=fab387&labelColor=303446&style=for-the-badge">
11+
</a>
12+
<a href="https://github.com/IogaMaster/loom/stargazers">
13+
<img src="https://img.shields.io/github/stars/IogaMaster/loom?color=ca9ee6&labelColor=303446&style=for-the-badge">
14+
</a>
15+
<a href="https://github.com/IogaMaster/loom">
16+
<img src="https://img.shields.io/github/repo-size/IogaMaster/loom?color=ea999c&labelColor=303446&style=for-the-badge">
17+
</a>
18+
<a href="https://github.com/IogaMaster/loom/blob/main/.github/LICENCE">
19+
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=ca9ee6&colorA=313244&colorB=cba6f7"/>
20+
</a>
21+
<br>
22+
</div>
23+
<img href="https://builtwithnix.org" src="https://builtwithnix.org/badge.svg"/>
24+
</h1>
25+
<br>
26+
27+
`loom` is a simple game engine implemented in Rust.
28+
29+
30+
## 📦 Installation and Usage
31+
- TODO
32+
33+
## 🔨 TODO
34+
- Vulkan renderer
35+
- ECS
36+
- Asset Manager
37+
38+
## ❤️ Contributing
39+
40+
Contributions are whole-heartedly welcome! Please feel free to suggest new features,
41+
implement additional builders, helpers, or generally assist if you'd like. We'd be happy to have you.
42+
There's more information in [CONTRIBUTING.md](CONTRIBUTING.md).
43+
44+
## 📜 License
45+
46+
Licensed under the MIT license ([LICENSE](LICENSE) or <https://opensource.org/licenses/MIT>).
47+
Unless you explicitly state otherwise, any contribution intentionally
48+
submitted for inclusion in this project by you, shall be licensed as above, without any additional terms or conditions.
49+

0 commit comments

Comments
 (0)