Skip to content

Commit

Permalink
Add GitHub Action for CI
Browse files Browse the repository at this point in the history
  • Loading branch information
chinedufn committed Mar 9, 2020
1 parent c50b366 commit 8ee4ce1
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: test

on: [push]

# TODO: Introduce caching https://github.com/actions/cache/blob/master/examples.md#rust---cargo
jobs:
test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- uses: actions-rs/cargo@v1

- name: Rust Version Info
run: rustc --version && cargo --version

- name: Run tests
run: cargo test --workspace
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ version = "0.1.0"
authors = ["Chinedu Francis Nwafili <[email protected]>"]
edition = "2018"
keywords = ["texture", "atlas", "bin", "rect", "box", "packer"]
description = "A minimal rectangle packer designed to conform to any two or three dimensional use case."
description = "A minimal bin packer designed to conform to any two or three dimensional use case."
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# rectangle-pack [![Actions Status](https://github.com/chinedufn/rectangle-pack/workflows/test/badge.svg)](https://github.com/chinedufn/rectangle-pack/actions) [![docs](https://docs.rs/rectangle-pack/badge.svg)](https://docs.rs/rectangle-pack)

> A minimal rectangle packer designed to conform to any two or three dimensional use case.
> A minimal bin packer designed to conform to any two or three dimensional use case.
`rectangle-pack` is a library focused on laying out any number of smaller rectangles (both 2d rectangles and 3d rectangular prisms) inside any number of larger rectangles.

Expand Down Expand Up @@ -124,7 +124,7 @@ I'm working on a game with some of the following texture atlas requirements (as
- For example - say there is a grass texture that is used in every grassy region of the game. Say each of those regions has some textures that are only used in that region and thus relegated to their own
atlas. We want to make sure our grass texture is copied into each of those textures so that one texture can support the needs of that region instead of two.

These requirements will be used as guiding pillars to design a flexible API.
These requirements are the initial guiding pillars to design the rectangle-pack API.

The API shouldn't know about the specifics of any of these requirements - it should just provide the bare minimum required to make them possible. We're trying to push as much into user-land as possible and leave
`rectangle-pack`s responsibility to not much more than answering:
Expand Down

0 comments on commit 8ee4ce1

Please sign in to comment.