Skip to content

Commit

Permalink
Merge pull request #2 from michaelbrusegard/formatting
Browse files Browse the repository at this point in the history
Formatting
  • Loading branch information
michaelbrusegard authored Aug 20, 2024
2 parents 9a54fd3 + 6e82e7c commit 079884f
Show file tree
Hide file tree
Showing 10 changed files with 1,514 additions and 525 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Rust CI

on:
push:
branches:
- main
pull_request:
branches:
- main

defaults:
run:
working-directory: ./gloom-rs

jobs:
build-check:
name: Build Check
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Setup Rust
uses: moonrepo/setup-rust@v1
with:
components: rustc, cargo
- name: Build Project
run: cargo build --verbose

format-check:
name: Format Check
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Setup Rust
uses: moonrepo/setup-rust@v1
with:
components: rustfmt
- name: Check Formatting
run: cargo fmt -- --check

lint-check:
name: Lint Check
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Setup Rust
uses: moonrepo/setup-rust@v1
with:
components: clippy
- name: Run Clippy
run: cargo clippy -- -D warnings
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Visual Computing Fundamentals

## Gloom-rs

This is a simple OpenGL Rust project.

To get started enter the project directory:

```bash
cd gloom-rs
```

### Requirements

- Rust
- Cargo

### Running the Project

You can run the project using the following command:

```bash
cargo run
```

This will compile and run the project.

If you want to run the project with rendering on a separate thread, use the following command:

```bash
cargo run --bin thread
```

This will run the project with rendering on a separate thread.
5 changes: 5 additions & 0 deletions gloom-rs/.rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
edition = "2021"
max_width = 110
tab_spaces = 3
newline_style = "Unix"
use_small_heuristics = "Max"
Loading

0 comments on commit 079884f

Please sign in to comment.