Commit graph

62 commits

Author SHA1 Message Date
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
Carter Anderson
88577d2880 update readme 2020-08-10 00:07:00 -07:00
Carter Anderson
c9d6acd932 update readme 2020-08-09 16:34:18 -07:00
Carter Anderson
bc6194a2f8 remove legion references from readme 2020-08-06 14:38:32 -07:00
Carter Anderson
5647a17c8e update readme 2020-08-06 13:58:13 -07:00
Carter Anderson
9d45a058b5 update links 2020-08-04 19:57:55 -07:00
Carter Anderson
1c976ea5b8 update readme 2020-07-22 19:07:28 -07:00
Carter Anderson
5bf7e92c23 remove shaderc from readme 2020-06-08 01:31:31 -07:00
Carter Anderson
4568f5dae3 remove specialization. bevy now builds on stable rust! 2020-06-07 23:36:39 -07:00
Carter Anderson
d79caf76b4 fix bevy book link 2020-05-30 13:10:20 -07:00
Carter Anderson
bf7f222318 Support async texture loading 2020-05-15 19:30:02 -07:00
Carter Anderson
7b79b3de8d organize examples and add ecs guide 2020-05-01 13:12:47 -07:00
Carter Anderson
fa81289fc7 try using an image link 2020-04-24 18:01:50 -07:00
Carter Anderson
45e28ef32b add modular design as a goal 2020-04-06 22:11:28 -07:00
Carter Anderson
574bc93e4f expand top level crate docs slightly and add hello world example 2020-04-06 17:39:06 -07:00
Carter Anderson
ecf89a5ba7 Add some top level bevy crate docs 2020-04-06 17:21:15 -07:00
Carter Anderson
398c89d307 use "min_specialization" feature 2020-04-06 15:54:17 -07:00
Carter Anderson
5b83698738 add move roadmap, readme, and faq to the bevy website 2020-04-04 21:48:44 -07:00
Carter Anderson
faaf307edb smaller bevy logo 2020-03-20 11:43:14 -07:00
Carter Anderson
f37f4caa72 update logos 2020-03-20 00:33:22 -07:00
Carter Anderson
7eb99f3eb5 finish uniform names refactor 2020-02-22 15:01:11 -08:00