Commit graph

43 commits

Author SHA1 Message Date
James Leflang
cc0ee536f0 Add note about linker errors for Fedora users (#2009)
This PR adds a note to the Fedora section of Linux Dependencies on solving linker errors.

Fixes #1815.

Co-authored-by: James Leflang <59455417+jleflang@users.noreply.github.com>
2021-04-27 02:41:34 +00:00
MinerSebas
4c86b99d2f Update cargo_features.md (#1939)
This adds missing features to the cargo_features.md file.

closes #1391
2021-04-16 18:57:08 +00:00
Saverio Miroddi
b80814681a Add g++ to the Ubuntu dependencies (#1874)
The g++ package may not be preinstalled.

Also, replaced the mention of "fast" compiles, with generic instructions about how to install clang; this is because on my test system, clang didn't make any difference, and it's likely not to do any in general, as it is a relatively small part of the build.

Closes #1294.
2021-04-14 22:02:52 +00:00
follower
50df6b61f2 Typo fix: "wit" -> "with". (#1876) 2021-04-13 20:02:20 +00:00
Nathan Stocks
60f286d56d Update linters.md with info about cargo ci xtask (#1507)
Update `linters.md` with info about `cargo ci` xtask as per https://github.com/bevyengine/bevy/pull/1463#pullrequestreview-593747890

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2021-04-12 19:11:40 +00:00
Alice Cecile
100e516014 Release Checklist (#1834)
To help make the process easier and more fool-proof, aid delegation and document institutional knowledge.

I'm not entirely sure where this belongs.
2021-04-08 21:33:46 +00:00
MinerSebas
8a9f475edb Remove the Clippy "-A clippy::manual-strip" override (#1619)
That override was added to support pre 1.45 Versions of Rust, but Bevy requires currently the latest stable rust release.
This means that the reason for the override doesn't apply anymore.
2021-03-12 03:05:14 +00:00
Psychoticpotato
2a3a32b66f Add mesa-vulkan-drivers to Debian install (#1489)
I received the `Unable to find GPU` error, but I got it to render by using this package.  Not 100% sure if a better option exists.
2021-03-07 19:17:25 +00:00
Niklas Eicker
15aaa2b297 Fix broken link in plugin guidelines (#1513)
I stumbled over a broken link in the plugin guidelines

Co-authored-by: Niklas Eicker <git@nikl.me>
2021-03-03 23:17:48 +00:00
Marek Fajkus
a5170625dc Update and simplify NixOS documentation (#1495)
Some updates and simplifications to the NixOS specific part of documentation.
2021-03-03 03:27:02 +00:00
MinerSebas
c9f19d8663 Cleanup of Markdown Files and add CI Checking (#1463)
I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo.
The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md

Rules I didn't follow/fix:
* MD024/no-duplicate-heading
  * Changelog: Here Heading will always repeat.
  * Examples Readme: Platform-specific documentation should be symmetrical.
* MD025/single-title
* MD026/no-trailing-punctuation
  * Caused by the ! in "Hello, World!".
* MD033/no-inline-html
  * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much.
* ~~MD036/no-emphasis-as-heading:~~
  * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~
* ~~MD041/first-line-heading~~
  * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~

---

I also sorted the Examples in the Readme and Cargo.toml in this order/Priority:
* Topic/Folder
* Introductionary Examples
* Alphabetical Order

The explanation for each case, where it isn't Alphabetical :
* Diagnostics
  * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own.
* ECS (Entity Component System)
  * ecs_guide: The guide should be read, before diving into other Features.
* Reflection
  * reflection: Basic Explanation should be read, before more advanced Topics.
* WASM Examples
  * hello_wasm: It's "Hello, World!".
2021-02-22 04:50:05 +00:00
Daniel McNab
041fd27b0a Update all references to use main (#1483)
In this case, the previous section header linked to in second badge in `plugins_guidelines` didn't actually exist, so I just linked to the same section as the first badge

Also I need to check that github handles the relative links correctly
2021-02-19 21:25:52 +00:00
dinococo
3adcba9461
Grammar fixes (#1390)
* Minor grammar fixes

* Minor grammar fixes

Fixed punctuation and wording.

* Minor grammar fixes

FIxed spelling, wording and formatting.
2021-02-03 19:15:25 -08:00
François
cf5f3b5008
Plugin guidelines (#1250)
* add plugin guidelines
* refactor features list
2021-01-31 20:19:10 -08:00
Spencer Burris
06dbfffe2e
Update default features in docs/cargo_features.md (#1287) 2021-01-31 17:03:54 -08:00
Nathan Jeffords
60be99859a
Subpixel text positioning (#1196)
* cleanup unnecessary changes from PR #1171

* add feature to correctly render glyphs with sub-pixel positioning
2021-01-03 12:39:11 -08:00
ColonisationCaptain
c32c78fc66
Update fedora version (#1111) 2020-12-24 13:30:36 -06:00
Tiago Ferreira
2e2423139e
Update dependencies for Enable Fast Compiles (#1065)
Added clang as an optional dependency to avoid frustration of running into compile error the first time you run a cargo build
2020-12-14 23:10:58 -08:00
MGlolenstine
23fcdfae56
Grammar correction (#856)
* Grammar correction
* Adjust for cart's personal taste

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2020-11-15 11:33:21 -08:00
Carter Anderson
e03f17ba7f
Log Plugin (#836)
add bevy_log plugin
2020-11-12 17:23:57 -08:00
MGlolenstine
ec7ad4254c
Fixed grammar and wording (#840)
Changed grammar and wording on two entries to make them easier to understand and fit better into the context (make MP3 format fit better alongside the audio formats).
2020-11-11 12:09:02 -08:00
Rob
06f95e9982
Fixed several typos. (#806)
* Fixed common typo in several struct names.

* Fixed minor doc typos.
2020-11-06 17:11:12 -08:00
Emanuel Lindström
a592ef0562
Add WSL 2 instructions to linux_dependencies.md (#727)
Update linux_dependencies.md

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2020-10-28 18:51:51 -07:00
CGMossa
58eb7e7e05
Documenting small things here and there.. (#706)
Documenting small things here and there..
2020-10-21 15:57:03 -07:00
Kenneth Dodrill
e89301ad29
Add Void Linux to linux dependencies file (#645)
Figured I'd add it above NixOS since that one is way more verbose than the rest, but happy to move it below if desired :)
2020-10-08 10:28:56 -07:00
Léo Gillot-Lamure
d562063abf
Add systemd-devel for Fedora Linux dependencies (#528)
It is required for the dependency crate libudev-sys (error about missing libudev.pc)
2020-09-21 13:53:17 -07:00
Zooce
18a8532f32
Add libudev-dev to Ubuntu dependencies (#538) 2020-09-21 13:16:17 -07:00
memoryruins
f5146c1896
Update headless example / add feature docs (#502)
* Update headless example

* Add missing docs for features
2020-09-16 13:02:53 -07:00
figsoda
afe86b4b3a
Provide shell.nix for easier compiling with nix-shell (#491)
Embed shell.nix into docs/linux_dependencies.md
2020-09-14 14:34:43 -07:00
Nolan Darilek
ca4a2114a8
Add pkg-config as a Ubuntu 20.04 dependency. (#463)
This may need to be added for all Linux distros, but I'm testing in WSL2, and Ubuntu 20.04 was all I had.
2020-09-09 12:38:24 -07:00
Logan Collins
db8ec7d55f
add documentation for NixOS dependencies (#290) 2020-08-28 17:09:44 -07:00
Tom Bebb
c9000deafa
Add solus deps to linux_dependencies doc (#331)
Co-authored-by: Tom Bebbington <tophattedcoder@gmail.com>
2020-08-25 16:50:44 -07:00
VitalyR
c78187e6df
add an option about display server protocol, and create document docs/cargo_features.md (#249)
add an option about display server protocol, and create document `docs/cargo_features.md`
2020-08-24 17:06:08 -07:00
wyhaya
7b6fbcb932
Add Arch / Manjaro dependencies (#275) 2020-08-23 13:18:46 -07:00
Carter Anderson
7db4821287 add more tracing docs 2020-08-16 01:26:42 -07:00
Carter Anderson
9e1a1d15ea Add wgpu trace docs 2020-08-16 01:21:37 -07:00
André Heringer
576da50547
Update linux_dependencies.md
Add Fedora 32 dependencies.
2020-08-13 20:45:43 -03:00
Matteo Guglielmetti
5102893e71
Creates linux_dependecies.md
This document will be linked in the new "Install OS dependencies" section on the "Setup" page of the book.

See related issue at [this page](https://github.com/bevyengine/bevy-website/issues/6)
2020-08-13 09:59:03 +02:00
Zicklag
968fdbba9b
Add Note About Cargo Expand Pager 2020-08-12 19:22:01 -05:00
Zicklag
4977837fad
Add Cargo Expand to Macro Debugging Tips 2020-08-12 19:18:26 -05:00
Carter Anderson
f4b07ec9c7 update profiling doc 2020-06-10 00:24:28 -07:00
Carter Anderson
8a10c06ad5 add texture to frag shader. fix weird macro name collision bug 2020-02-18 20:26:02 -08:00
Carter Anderson
7a1036fa0b add quick profiling doc 2020-02-10 22:13:05 -08:00