Skip to content

Commit

Permalink
Add a readme, license, and GH workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
Raunak Bhagat committed May 30, 2024
1 parent d2c9937 commit c4b6da8
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 3 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/master.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Master

on:
push:
branches: [master]
pull_request:
branches: [master]

env:
CARGO_TERM_COLOR: always

jobs:
check-test-format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install latest nightly rust
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
override: false
components: rustfmt
- name: Assert project compiles
run: cargo check --verbose
- name: Assert all tests pass
run: cargo test --verbose
- name: Assert formatting is valid
run: cargo +nightly fmt --verbose --check
7 changes: 7 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2024 Raunak Bhagat

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Todo App
A basic todo add rendered using a custom-written rendering engine.
Focused on making it compatible on all platforms.
<h1 align="center">
metallic
</h1>
<div align="center">
<a href="./LICENSE-MIT">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
</a>
</div>
<br/>

A 2-dimensional "draw-only" rendering engine.
Renders using the GPU with the backend utilizing WebGPU APIs.
This library only issues draw commands; it does *not* handle any form of user IO.
That is left up to the consumer to implement.

## License
Licensed under the [MIT License](./LICENSE-MIT).

0 comments on commit c4b6da8

Please sign in to comment.