Skip to content

Commit eb8ba49

Browse files
bors[bot]grovesNL
andcommitted
Merge #2156
2156: Update README r=kvark a=grovesNL Fixes #1844 [Rendered](https://github.com/grovesNL/gfx/blob/cff24fbf60791f56bd6fdfd6c4a1e4a445d6e50c/README.md) - Add strikethrough to documentation link placeholder and note that it's still a work in progress - Add DirectX 11 everywhere in readme - Try to clarify pre-ll a bit more (open to other ideas?) Co-authored-by: Joshua Groves <[email protected]>
2 parents 39aff0d + cff24fb commit eb8ba49

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
<img src="info/logo.png">
33
</p>
44
<p align="center">
5-
<!--a href="https://docs.rs/gfx-hal">
6-
<img src="https://docs.rs/gfx-hal/badge.svg" alt="Documentation on docs.rs">
7-
</a-->
85
<a href="https://travis-ci.org/gfx-rs/gfx">
96
<img src="https://img.shields.io/travis/gfx-rs/gfx/master.svg?style=flat-square" alt="Travis Build Status">
107
</a>
@@ -18,7 +15,7 @@
1815
<img src="https://img.shields.io/badge/gitter-join%20chat-green.svg?style=flat-square" alt="Gitter Chat">
1916
</a>
2017
<br>
21-
<strong><a href="info/getting_started.md">Getting Started</a> | <a href="http://docs.rs/gfx-hal">Documentation</a> | <a href="http://gfx-rs.github.io/">Blog</a> </strong>
18+
<strong><a href="info/getting_started.md">Getting Started</a> | <s><!--<a href="http://docs.rs/gfx-hal">-->Documentation<!--</a>--></s> (work in progress) | <a href="http://gfx-rs.github.io/">Blog</a> </strong>
2219
</p>
2320

2421
# gfx-rs
@@ -28,14 +25,14 @@ gfx-rs is a low-level, cross-platform graphics abstraction library in Rust. It c
2825
* `gfx-hal` which is gfx's hardware abstraction layer: a Vulkan-ic mostly unsafe API which translates to native graphics backends.
2926
* `gfx-backend-*` which contains graphics backends for various platforms:
3027
* [Vulkan](src/backend/vulkan)
31-
* [DirectX 12](src/backend/dx12)
28+
* [DirectX 12](src/backend/dx12) and [11](src/backend/dx11)
3229
* [Metal](src/backend/metal)
3330
* [OpenGL 2.1+/ES2+](src/backend/gl)
3431
* `gfx-warden` which is a data-driven reference test framework, used to verify consistency across all graphics backends.
3532

3633
## Example
3734

38-
To run an example, simply use `cargo run` and specify the backend with `--features {backend}` (where `{backend}` is one of `vulkan`, `dx12`, `metal`, or `gl`). For example:
35+
To run an example, simply use `cargo run` and specify the backend with `--features {backend}` (where `{backend}` is one of `vulkan`, `dx12`, `dx11`, `metal`, or `gl`). For example:
3936

4037
```bash
4138
git clone https://github.com/gfx-rs/gfx
@@ -58,9 +55,11 @@ Currently HAL has backends for Vulkan, DirectX 12, Metal, and OpenGL/OpenGL ES/W
5855

5956
The HAL layer is consumed directly by user applications or libraries. HAL is also used in efforts such as [gfx-portability](https://github.com/gfx-rs/portability).
6057

61-
## pre-LL
58+
## Previously Released Crates and API (pre-LL)
59+
60+
The code in `master` is a complete low-level rewrite of gfx based on HAL as described above.
6261

63-
If you are looking for information about the released crates (`gfx_core`, `gfx`, `gfx_device_*`, `gfx_window_`, etc), they are being developed and published from the [pre-ll](https://github.com/gfx-rs/gfx/tree/pre-ll) branch. Code in `master` is a complete rewrite that will be shipped in different crates.
62+
The previously released crates (`gfx_core`, `gfx`, `gfx_device_*`, `gfx_window_`) are still being developed and published from the [pre-ll](https://github.com/gfx-rs/gfx/tree/pre-ll) (pre-low level rewrite) branch.
6463

6564
## License
6665

info/getting_started.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ For Ubuntu
1414

1515
```bash
1616
sudo apt install -y libx11-dev libvulkan-dev libxcb1-dev xorg-dev
17-
1817
```
1918

20-
For Linux, a Vulkan compatible driver must also be installed. For example, the open source ``` mesa-vulkan-drivers ``` for Intel or Radeon gpu's. The proprietary Nvidia drivers support Vulkan out of the box but, as of time of writing, Nouveau users are currenty limited to OpenGL.
19+
For Linux, a Vulkan compatible driver must also be installed. For example, the open source `mesa-vulkan-drivers` for Intel or Radeon gpu's. The proprietary Nvidia drivers support Vulkan out of the box but, as of time of writing, Nouveau users are currenty limited to OpenGL.
2120

2221
## Usage
2322

info/hal.svg

+8-7
Loading

0 commit comments

Comments
 (0)