From 020b42397c162ffdb122b0c39a55ddc9a7097cfc Mon Sep 17 00:00:00 2001 From: mitchellhansen Date: Thu, 9 Jan 2020 23:35:24 -0800 Subject: [PATCH] removed amethyst readme --- README.md | 66 ------------------------------------------------------- 1 file changed, 66 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 9fcde39..0000000 --- a/README.md +++ /dev/null @@ -1,66 +0,0 @@ -

- - Amethyst - -

-

- Amethyst 2D Starter -

- -This project template will get you from 0 to drawing something on the screen in no time. If you're looking for a more in-depth introduction to the engine, please have a look at [our book](https://book.amethyst.rs/stable/)! - -## Quickstart - -- Clone the repository - -```bash -git clone https://github.com/amethyst/amethyst-starter-2d.git -cd amethyst-starter-2d -``` - -- Build and run the project - -```bash -cargo run -``` - -#### For Mac Users - -This starter uses vulkan as a renderer by default. You'll want to change the backend to use `metal`, which can be done by opening the `Cargo.toml` file and changing - -```toml -[features] -default = ["vulkan"] -``` - -to - -```toml -[features] -default = ["metal"] -``` - -If using OSX and Metal you will require full XCode installed from the Appstore in order to compile metal shaders. -After install you may be required to run this command `sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer` [reference gfx-rs issue](https://github.com/gfx-rs/gfx/issues/2472) - -#### For Linux Users - -You might need to install some dependencies. Please refer to [this section](https://github.com/amethyst/amethyst#dependencies) of the README for more details. - -## Features - -This project contains the minimum amount of code needed to draw sprites to the screen. Here's a small summary of what you'll find in the source files: - -- `resources/display_config.ron` - Contains the window configuration (size, title). - -- `src/main.rs` - Creates the render graph, adds the required bundles, builds the game data with our own state and finally, starts the game's main event loop. - -- `src/state.rs` - Implements the main game state. In the `on_start` hook, the camera is initialized, and the sprites that will be drawn are loaded and their entities created. - In the `handle_event` hook, we print any keys that were pressed and close the window if the user presses escape or the OS requests that we quit.