Skip to content

Commit

Permalink
Update README.md (#270)
Browse files Browse the repository at this point in the history
* Update README.md

Ubuntu 18.04 also required the extra packages as mentioned under WSL, consolidating into one place.

* Add note to follow linux-specific instructions

* Update README.md
  • Loading branch information
mozmorris authored and bryphe committed Jan 28, 2019
1 parent a35fe3d commit 716b46f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Install the following packages with your package manager of choice:
* `libpng-dev`
* `libbz2-dev`
* `m4`
* `xorg-dev`
* `libglu1-mesa-dev`

#### For `Windows` native

Expand All @@ -48,7 +50,7 @@ No additional dependencies needed.
#### For `Windows` Subsystem for Linux (`WSL`)

- `sudo apt install libpng-dev libbz2-dev m4 xorg-dev libglu1-mesa-dev`
Make sure to check the specific requirements for your Linux distribution, above.

> __NOTE:__ Hardware acceleration is not enabled by default in WSL (instead, WSL will fall-back to a _software_ renderer). This is problematic for performance - for that reason, we recommend building and running Revery natively on Windows instead of with WSL. For more info see: (https://github.com/Microsoft/WSL/issues/637 and a [potential workaround](https://superuser.com/questions/1238925/use-accelerated-graphics-on-windows-10-linux-subsystem-with-xming))
Expand Down

0 comments on commit 716b46f

Please sign in to comment.