From 3f104fd7e9824086ba4d5bd417e49eb2ba815c1c Mon Sep 17 00:00:00 2001 From: "kaosat.dev" Date: Tue, 13 Aug 2024 00:35:18 +0200 Subject: [PATCH] docs(): various minor tweaks & added a disclaimer / warning to the main README --- README.md | 6 ++++++ TODO.md | 8 ++++++++ docs/avian/{readme.md => README.md} | 0 docs/quickstart/{readme.md => README.md} | 0 4 files changed, 14 insertions(+) rename docs/avian/{readme.md => README.md} (100%) rename docs/quickstart/{readme.md => README.md} (100%) diff --git a/README.md b/README.md index ea34243..2cbdbee 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,12 @@ inside Blender. Aka "Blender as editor for Bevy" It also allows you to setup 'blueprints' in Blender by using collections (the recomended way to go most of the time), or directly on single use objects . + +> [!CAUTION] +> Blenvy is currently in **Alpha** so there are still quite a few bugs, missing functionality, missing docs, broken examples etc +> Please make sure you back up your Blender files before using it ! + + ## Quickstart Want to jump right in? See the [quickstart guide](./docs/quickstart/readme.md) for how to setup a basic project as fast as possible. diff --git a/TODO.md b/TODO.md index 0bdf129..c33e168 100644 --- a/TODO.md +++ b/TODO.md @@ -362,6 +362,14 @@ Bevy Side: clear && pytest -svv --blender-template ../../testing/bevy_example/art/testing_library.blend --blender-executable /home/ckaos/tools/blender/blender-4.1.0-linux-x64/blender tests/test_bevy_integration_prepare.py && pytest -svv --blender-executable /home/ckaos/tools/blender/blender-4.1.0-linux-x64/blender tests/test_bevy_integration.py +----------- +PRE ALPHA1 RELEASE: +- compress images in blender docs +- add a small note about using the same version of the Blender add-on & the Bevy crate +- merge blenvy branch into main +- push to crates.io +- tag + ------------ POST ALPHA1 RELEASE: BEVY: diff --git a/docs/avian/readme.md b/docs/avian/README.md similarity index 100% rename from docs/avian/readme.md rename to docs/avian/README.md diff --git a/docs/quickstart/readme.md b/docs/quickstart/README.md similarity index 100% rename from docs/quickstart/readme.md rename to docs/quickstart/README.md