Skip to content

Commit

Permalink
add logo
Browse files Browse the repository at this point in the history
rework README
  • Loading branch information
leudz committed Mar 8, 2021
1 parent 6dd7634 commit 324ea32
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# Shipyard <!-- omit in toc -->
<div align="center">

# Shipyard <sub><img src="./logo.png" width=32> </sub> <!-- omit in toc -->

Shipyard is an Entity Component System focused on usability and speed.

If you have any question or want to follow the development more closely <sub>[![Chat](https://img.shields.io/badge/join-Zulip-brightgreen.svg)](https://shipyard.zulipchat.com)</sub>.

[![Crates.io](https://img.shields.io/crates/v/shipyard)](https://crates.io/crates/shipyard)
[![Documentation](https://docs.rs/shipyard/badge.svg)](https://docs.rs/shipyard)
[![LICENSE](https://img.shields.io/crates/l/shipyard)](LICENSE-APACHE)

If you have any question or want to follow the development more closely <sub>[![Chat](https://img.shields.io/badge/join-Zulip-brightgreen.svg)](https://shipyard.zulipchat.com)</sub>.
### [Guide](https://leudz.github.io/shipyard/guide) | [Demo](https://leudz.github.io/shipyard/bunny_demo)

Learning resources:
- [Guide](https://leudz.github.io/shipyard/guide)
</div>

## Basic Example <!-- omit in toc -->
```rust
use shipyard::{IntoIter, View, ViewMut, World};

struct Health(u32);
struct Position {
_x: f32,
_y: f32,
x: f32,
y: f32,
}

fn in_acid(positions: View<Position>, mut healths: ViewMut<Health>) {
Expand All @@ -38,11 +41,10 @@ fn is_in_acid(_: &Position) -> bool {
fn main() {
let mut world = World::new();

world.add_entity((Position { _x: 0.0, _y: 0.0 }, Health(1000)));
world.add_entity((Position { x: 0.0, y: 0.0 }, Health(1000)));

world.run(in_acid).unwrap();
}

```

## Small Game Example <!-- omit in toc -->
Expand Down
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 324ea32

Please sign in to comment.