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.

Sign up for GitHub

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

Improve Getting Started: macOS instructions #2473

Merged
merged 1 commit into from
Nov 14, 2018
Merged

Improve Getting Started: macOS instructions #2473

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 10 additions & 7 deletions info/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# Getting Started

## macOS Dependencies

Install the newest XCode from the App Store. This installs the required `metal` developer tools.

## Vulkan Dependencies

First, install the x11 and Vulkan dev libraries.

For Fedora

```bash
# Fedora
sudo dnf install -y libX11-devel vulkan
```

For Ubuntu

```bash
# Ubuntu
sudo apt install -y libx11-dev libvulkan-dev libxcb1-dev xorg-dev
```

Expand All @@ -27,7 +26,11 @@ To run an example, simply use `cargo run` and specify the backend with `--featur
```bash
git clone https://github.com/gfx-rs/gfx
cd gfx/examples
# macOS
cargo run --bin quad --features metal
# vulkan
cargo run --bin quad --features vulkan
# Windows
cargo run --bin compute --features dx12 1 2 3 4
```

Expand Down