Commit graph

82 commits

Author SHA1 Message Date
Paul Kupper
dedf66f72b
Replace references to old book with quick start guide (#11983)
# Objective

Since https://github.com/bevyengine/bevy-website/pull/880, the old book
is now the Quick Start Guide, but the references to the old book have
not been updated.

## Solution

Update references to the old book to point to the Quick Start Guide.
2024-02-19 20:25:35 +00:00
TrialDragon
c1b785c360
Migrate third party plugins guidelines to the book (#11242)
# Objective

- Describe the objective or issue this PR addresses.
- If you're fixing a specific issue, say "Fixes #X".

Removes the old third party plugin guidelines section and related links
since it is being moved to the Bevy book in the site per
https://github.com/bevyengine/bevy-website/pull/848 and
https://github.com/bevyengine/bevy-website/issues/298

## Solution

- Describe the solution used to achieve the objective above. 

Removes the old links and files.
2024-01-07 23:19:37 +00:00
Carter Anderson
2c5639e323
Remove references to specific projects from the readme (#10836)
Bevy builds on a ton of different libraries. Choosing who gets "prime
real estate" in the readme is hard / political. Closing that can of
worms makes a lot of sense to me.

I have also removed the "alternatives" section for similar reasons.
There are a number of engines/libs that aren't credited there, some of
those listed no longer exist / aren't maintained, and it isn't really
our job to be the canonical source. Each alternative listed is a soft
endorsement of the project (and the reverse is true for projects we
don't include). Again, closing this can of worms feels like the right
call.
2023-12-05 02:05:57 +00:00
Rob Parrett
d857cd6575
Fix orphaned contributing paragraph (#10174)
# Objective

This paragraph was missed in #10171

## Solution

Put it in the contributing section
2023-10-18 15:52:04 +00:00
KshitijAucharmal
2580b3d74c
Added section for contributing and links for issues and PRs (#10171)
# Objective

- Add a header for contributing to make it easier for people new to
github for getting started.
- Adding links that point to issues and PRs

## Solution

- Updated the README.md to show a contributing section under the
Community header
- Added links in the section to point to issued and PRs
2023-10-18 15:06:15 +00:00
Ame :]
b9ddb37d5b
add and fix shields in Readmes (#9993)
# Objective

Fix shields

## Solution

- Correct shield in the Bevy ECS Readme, where only the MIT license is
displayed
![Screenshot 2023-10-01 at 18 28
27](https://github.com/bevyengine/bevy/assets/104745335/a736a65e-0d47-4d9e-b32d-0b843a00922c)
- Add shields to other Readmes.
- homogenize shields and titles.
2023-10-15 00:52:31 +00:00
SykiK
019649422b
Fixed: README.md (#9994)
# Objective

fixed readme.md.

## Solution

removed 'iOS cron CI' badge as its source
(https://github.com/bevyengine/bevy/workflows/iOS%20cron%20CI/badge.svg)
is not available anymore
2023-10-02 13:07:29 +00:00
Ame
ea41a43fae
Clarify that wgpu is based on the webGPU API (#9093)
# Objective

wgpu is not only inspired by Vulkan, so I think it's better to just
mention that it's based on WebGPU

## Solution

- Change the description
2023-07-14 18:54:44 +00:00
张林伟
6b55667bee
Update MSRV desc in README.md (#8546)
# Objective

- Update MSRV desc in README.md
2023-05-09 13:52:53 +00:00
François
21dc3abe1b
daily job running mobile example on real devices (#8216)
# Objective

- Test mobile example on real devices

## Solution

- Use [BrowserStack](https://www.browserstack.com) to have access to
[real
devices](https://www.browserstack.com/list-of-browsers-and-platforms/app_automate)
- [App Automate](https://www.browserstack.com/app-automate) to run the
example
- [App Percy](https://www.browserstack.com/app-percy) to compare the
screenshot
- Added a daily/manual CI job that will build for iOS and Android, send
the apps to BrowserStack, run the app on one iOS device and one Android
device, capture a screenshot, send it for visual validation, and archive
it in the GitHub action

Example run: https://github.com/mockersf/bevy/actions/runs/4521883534

They currently have a bug with the settings to view snapshots, they
should be public. I'll raise it to them, and if they don't fix it in
time it's possible to work around for everyone to view the results
through their API.

@cart to get this to work, you'll need
- to set up an account on BrowserStack
- add the secrets `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY`
to the Bevy repo
- create a project in Percy
- add the secret `PERCY_TOKEN` to the Bevy repo and modify the project
name line 122 in the `Daily.yml` file
2023-03-28 23:16:07 +00:00
Nico Burns
cc37b59b95
Clarify breaking release frequency (#7934)
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2023-03-07 22:02:07 +00:00
Peter Hebden
51fce7e13f Update license link in README.md (#5614)
# Objective

The `LICENSE` file in the root directory was removed in #4966. This breaks the license shield link in the README.

## Solution

I changed the link to instead point at the license section of the readme on the main repo page. I think this is better than a 404, but I am unsure as to if it's the best solution. As such feedback is appreciated.
2022-08-08 19:39:07 +00:00
Alice Cecile
db86023069 Note that changes to licensing are controversial (#4975)
# Objective

- In #4966, @DJMcNab noted that the changes should likely have been flagged as controversial, and blocked on a final pass from @cart.
  - I think this is generally reasonable.
  - Added as an explicit guideline.
- Changes to top-level files are also typically controversial, due to the high visible impact (see #4700 for a case of that).
  - Added as an explicit guideline.
- The licensing information of our included assets is hard to find.
   - Call out the existence of CREDITS.md
2022-07-20 17:05:43 +00:00
Charles
518408dfda Remove spirv-reflect from readme (#5192)
# Objective

- The libraries used section of the README is outdated and is missing a lot of libraries
- The README isn't really the place for that anyway

## Solution

- Remove the section
2022-07-09 01:05:06 +00:00
Alice Cecile
050251da5a Add standard Bevy boilerplate to README.md (#5191)
@BoxyUwU says that she always looks for this here, following the example of [tetra](https://github.com/17cupsofcoffee/tetra).

I think this is a pretty sensible idea!
2022-07-04 13:04:21 +00:00
Cai Bingjun
5ace79ff09 Let the project page support GitHub's new ability to display open source licenses (#4966)
Change _LICENSE-APACHE_ and _LICENSE-MIT_ file location
Delete _LICENSE_
You can make the license in about on bevy's GitHub page display as **Apache-2.0, MIT licenses found** instead of **View license**
2022-06-08 17:55:57 +00:00
Alice Cecile
fa791d6bb8 Make a note about the MSRV (#4274)
# Objective

- Users occasionally ask about the latest supported Rust version.
- Fixes #288 (kinda).

## Solution

- We use "latest stable release".
- Document this information in the README.
2022-03-21 16:20:34 +00:00
Charles
519148275d Rename rg3d to Fyrox in README (#4032)
# Objective

 rg3d has been renamed to Fyrox for a little while now and we should reflect that. It's not particularly urgent since the old link redirects to Fyrox.

## Solution

Rename rg3d to Fyrox in the README
2022-02-24 22:38:55 +00:00
Carter Anderson
4134577e64 Fix Code of Conduct bolding in readme (#3822) 2022-01-31 02:30:05 +00:00
Alice Cecile
97c806585b README refresh (#3513)
# Objective

- The focus areas and roadmap are very stale.
- Some of the information about how to learn or contribute to Bevy are outdated

## Solution

- Remove links to focus areas and roadmap (roadmap still exists, and will be updated post-release).
- Link to Bevy Assets, CONTRIBUTING.md and official examples.
2022-01-01 19:41:20 +00:00
Carter Anderson
e167a1d9cf Relicense Bevy under the dual MIT or Apache-2.0 license (#2509)
This relicenses Bevy under the dual MIT or Apache-2.0 license. For rationale, see #2373.

* Changes the LICENSE file to describe the dual license. Moved the MIT license to docs/LICENSE-MIT. Added the Apache-2.0 license to docs/LICENSE-APACHE. I opted for this approach over dumping both license files at the root (the more common approach) for a number of reasons:
  * Github links to the "first" license file (LICENSE-APACHE) in its license links (you can see this in the wgpu and rust-analyzer repos). People clicking these links might erroneously think that the apache license is the only option. Rust and Amethyst both use COPYRIGHT or COPYING files to solve this problem, but this creates more file noise (if you do everything at the root) and the naming feels way less intuitive. 
  * People have a reflex to look for a LICENSE file. By providing a single license file at the root, we make it easy for them to understand our licensing approach. 
  * I like keeping the root clean and noise free
  * There is precedent for putting the apache and mit license text in sub folders (amethyst) 
* Removed the `Copyright (c) 2020 Carter Anderson` copyright notice from the MIT license. I don't care about this attribution, it might make license compliance more difficult in some cases, and it didn't properly attribute other contributors. We shoudn't replace it with something like "Copyright (c) 2021 Bevy Contributors" because "Bevy Contributors" is not a legal entity. Instead, we just won't include the copyright line (which has precedent ... Rust also uses this approach).
* Updates crates to use the new "MIT OR Apache-2.0" license value
* Removes the old legion-transform license file from bevy_transform. bevy_transform has been its own, fully custom implementation for a long time and that license no longer applies.
* Added a License section to the main readme
* Updated our Bevy Plugin licensing guidelines.

As a follow-up we should update the website to properly describe the new license.

Closes #2373
2021-07-23 21:11:51 +00:00
Daniel McNab
3a20462d3f Useful changes with relicensing benefits (#2497)
This obsoletes #1111 and #2445, since @ColonisationCaptain and @temhotaokeaha haven't replied to #2373.

I believe that both of those PRs would be fine to keep, but they're even more fine to keep now :)
2021-07-17 21:59:31 +00:00
TEMHOTAOKEAHA
17bd3f954f wgpu has been moved from "wgpu-rs" to "wgpu" (#2445)
Name and link update
2021-07-09 21:33:16 +00:00
François
b52edc107d use discord vanity link (#2420)
# Objective

I wanted to send the Bevy discord link to someone but couldn't find a pretty link to copy paste 

## Solution

Use the vanity link we have for discord
2021-07-01 20:41:42 +00:00
David McClung
f602dcf643 Fixes #2079 with a New SVG File (#2290)
Fixes #2079 
Closes #2288 

Modifies README.md, and creates a new SVG file for the logo.  When Github appearance is in Dark Dimmed, the blackbird and BEVY text of the logo should not blend into the black background.
2021-06-02 02:11:04 +00:00
Jasen Borisov
8e3532e8f7 README/examples: better direct users to the release version (#1624)
1. The instructions in the main README used to point users to the git main version. This has likely misdirected and confused many new users. Update to direct users to the latest release instead.
2. Rewrite the notice in the examples README to make it clearer and more concise, and to show the `latest` git branch.

See also: https://github.com/bevyengine/bevy-website/pull/109 for similar changes to the website and official book.
2021-03-12 02:46:51 +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
François
cf5f3b5008
Plugin guidelines (#1250)
* add plugin guidelines
* refactor features list
2021-01-31 20:19:10 -08:00
Jasen Borisov
8e69ff2c2b
README: explicitly link to Learning section of awesome-bevy (#1330)
README: link to Learning section of awesome-bevy
2021-01-29 11:36:02 -08:00
TotalKrill
5146112f5f
Add discord shield badge to README (#1332)
This would highlight how active the community really is at just a glance, which is nice. It will however require an admin of the discord server to activate this under Server Settings->Widget-> enable server widget
2021-01-28 14:05:09 -08:00
Nathan Stocks
940bcf9b0f
Add Contributing Info (#1309)
* Add a CONTRIBUTING.md

* Point to book. Add tools/ci script.

* Update contributing link to point to book
2021-01-26 12:05:33 -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
simlay
9cc6368b28
An initial xcode setup for using xcode (#539)
An example of bevy using xcode
2020-10-31 14:36:24 -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
Carter Anderson
3dbc6550a0
add rg3d to "alternatives" 2020-09-24 18:45:17 -07:00
Zicklag
35c323469f
Improve README Readability Around Cargo Features (#511) 2020-09-18 20:13:07 -07:00
Carter Anderson
5288ec9859 Revert "test github branch policy"
This reverts commit 73f0b8e5f9.
2020-09-03 17:42:38 -07:00
Carter Anderson
73f0b8e5f9 test github branch policy 2020-09-03 17:40:34 -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
Forest Anderson
6c43afff08
Added CI badge to readme, changed workflow name (#325) 2020-08-24 11:16:52 -07:00
Carter Anderson
d00ce1c61c 1000 commits! 2020-08-24 00:42:07 -07:00
DGriffin91
20335d5643
Add links to Stack Overflow and Awesome Bevy (#282) 2020-08-21 18:11:03 -07:00
Carter Anderson
6b11e58dcd readme formatting tweaks 2020-08-21 15:06:50 -07:00
Halfwhit
bfd6e4a935
Add linux dependencies to README.md (#257)
* Add linux dependencies to README.md

* Update README.md
2020-08-21 14:59:34 -07:00
Carter Anderson
fc53ff9a71 Add "Focus Areas" to readme 2020-08-21 12:50:05 -07:00
GabLotus
3c5251f6f2
Updating README.md with subreddit info and link to Code of Conduct (#263)
* update readme
2020-08-20 17:03:26 -07:00
adekau
5f5875c8c9
Fix 404 link to License file 2020-08-11 15:10:32 -04:00
Gab Campbell
5d58fe3d12 Add discord server link to bevy readme 2020-08-10 23:16:50 -07:00
Carter Anderson
1d68094f59 add link to "introducing bevy" blog post 2020-08-10 02:08:55 -07:00