Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean readme #497

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/game-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Request a game addition
about: Ask for a game to be added to Are We Game Yet
title: ''
labels: addition, good first issue
assignees: ''

---

Fill out as many of the fields as you can, and remove any that you don't need:

```toml
[[items]]
# The name of the item. Mandatory.
name = "My crate"

# A short description of the item. Optional, but recommended.
description = "My extremely cool Rust crate"

# The categories that your item should be assigned to. Mandatory.
categories = ["2drendering", "engines"]

# An image representing the item. Files should be checked in to
# /static/assets/img/, and the path should be absolute.
# Optional, but highly recommended for games!.
image = "/assets/img/logo.png"

# A link to the item's page on Crates.io. Optional.
crate_url = "https://crates.io/crates/mycrate"

# A link to the item's VCS repository. Optional.
repository_url = "https://github.com/username/repo"

# A link to the item's homepage. Optional.
homepage_url = "https://mycrate.com"

# A link to the item's Gitter chat. Optional.
gitter_url = "https://gitter.im/mycrate"
```
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,37 @@
# README
# Are We Game Yet

## What is this?

The Rust community has a number of websites dedicated to keeping track of the state of the ecosystem for specific purposes. (e.g. [arewewebyet](https://www.arewewebyet.org) and [arewelearningyet](https://www.arewelearningyet.com))
The Rust community has a number of websites dedicated to keeping track of the
state of the ecosystem for specific purposes. (e.g. [arewewebyet] and
[arewelearningyet])

This one tracks the state of the ecosystem for Game Development in Rust.

[arewewebyet]: https://www.arewewebyet.org
[arewelearningyet]: https://www.arewelearningyet.com

## Contribute

Arewegameyet? uses [semantic-ui](https://semantic-ui.com/), and [zola](https://github.com/getzola/zola) the Rust static site generator.
Arewegameyet? uses [semantic-ui](https://semantic-ui.com/), and
[zola](https://github.com/getzola/zola), the Rust static site generator. The
site currently builds with Zola 0.15.3. To get started with adding your own
project, you can do the following:

1. Navigate to whichever folder in `/content` best fits your project.
2. Edit that folder's `data.toml` file in any plain text editor or straight
through [GitHub's editor][github-editor-docs].
3. Create a new entry, following the schema described below. Note that all
entries should be sorted alphabetically by the `name` field, ignoring case.
There is a CI check to ensure this is done correctly - you can use the
`sort_data.py` script to automatically fix a file.

2. Edit that folder's `data.toml` file in any plain text editor or straight through [GitHub's editor](https://help.github.com/articles/editing-files-in-another-user-s-repository/).

3. Create a new entry, following the schema described below. Note that all entries should be sorted alphabetically by the `name` field, ignoring case. There is a CI check to ensure this is done correctly - you can use the `sort_data.py` script to automatically fix a file.
**All done!** We do greatly appreciate PRs, but if you're not comfortable with
this process, you're welcome to [open an issue][open-an-issue] requesting the addition of your
project instead.

**All done!** We do greatly appreciate PRs, but if you're not comfortable with this process, you're welcome to open an issue requesting the addition of your project instead.
[github-editor-docs]: https://help.github.com/articles/editing-files-in-another-user-s-repository/
[open-an-issue]: https://github.com/rust-gamedev/arewegameyet/issues/new/choose

### Schema

Expand Down Expand Up @@ -65,14 +80,20 @@ source = "github"
categories = ["mycategory"]
```

Extra keys can be added to items that are pulled from external data (e.g. to add a homepage URL, or override some of the fetched data).
Extra keys can be added to items that are pulled from external data (e.g. to add
a homepage URL, or override some of the fetched data).

### Enhance this website

If you're comfortable with semantic-ui and Zola please reach out to us in the Issues with your enhancement ideas or just to state your willingness to contribute.
If you're comfortable with semantic-ui and Zola please reach out to us in the
Issues with your enhancement ideas or just to state your willingness to
contribute.

[awgy-issues]:

### Errors

It's very likely there are mistakes around, if you find one please file an issue.
It's very likely there are mistakes around, if you find one please file an
issue.

*Thanks for helping us map the Rust game development ecosystem!*
2 changes: 1 addition & 1 deletion content/games/data.toml
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ image = "/assets/img/rustyroad.png"
[[items]]
name = "Veloren"
description = "An open source multiplayer voxel RPG game currently in alpha development."
categories = ["rpg", "open-world"]
categories = ["rpg", "open-world", "simulation"]
homepage_url = "//veloren.net"
image = "/assets/img/veloren.jpg"

Expand Down
Binary file modified static/assets/img/veloren.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.