tirbofish/dropbear · commit

e73acf664d6e32e5a10edd58bb9867e4cfb6347a

fix: update the fuckups i made with the READMEs (now they got published and the links are broken :( )

tk <4tkbytes@pm.me> · 2025-07-24 14:15

view full diff

diff --git a/README.md b/README.md
index df29c73..b5e1a24 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,38 @@
 # dropbear
 
-dropbear is a game engine used to create games. It's made in rust. 
+dropbear is a game engine used to create games. It's made in rust. It's name is a double entendre, with it being the nickname of koalas but also fits in nicely with the theme of rust utilising "drops".
 
-If you might have nbot realised, 
+If you might have not realised, all the crates/projects names are after Australian flora and fauna.
 
 ## Related projects
 
- - [eucalyptus](https://github.com/4tkbytes/dropbear/eucalyptus) is the visual editor used to create games visually, taking inspiration from Unity and other engines. 
- - [redback](https://github.com/4tkbytes/dropbear/redback) is the build system used by [eucalyptus](https://github.com/4tkbytes/dropbear/eucalyptus) to bind, build and ship games made with the engine. 
\ No newline at end of file
+ - [eucalyptus](https://github.com/4tkbytes/dropbear/tree/main/eucalyptus) is the visual editor used to create games visually, taking inspiration from Unity and other engines.
+ - [redback](https://github.com/4tkbytes/dropbear/tree/main/redback) is the build system used by [eucalyptus](https://github.com/4tkbytes/dropbear/tree/main/eucalyptus) to bind, build and ship games made with the engine.
+
+ ## Build
+
+ To build, clone the repository, then build it. It will build in debug mode, and use a lot of packages, so if your CPU is not fast enough for building you should brew a cup of coffee during the build time.
+ ```bash
+ git clone git@github.com:4tkbytes/dropbear
+ cd dropbear
+ # this will build all the projects in the workspace, including eucalyptus and redback.
+ cargo build
+ ```
+
+## Usage
+
+Depsite it looking like a dependency for `eucalyptus`, it can serve as a framework too. Looking through the `docs.rs` will you find related documentation onhow to use it and for rendering your own projects.
+
+## Compability
+
+|            | Windows | macOS | Linux | Web | Android | iOS |
+|------------|---------|-------|-------|-----|---------|-----|
+| dropbear   |    ✅    |   ✅   |   ✅   |  ❌  |    ❌    |  ❌  |
+| eucalyptus |    ✅    |   ✅   |   ✅   |  ❌  |    ❌    |  ❌  |
+| redback    |    ✅    |   ✅   |   ✅   |  ❌  |    ❌    |  ❌  |
+
+To be fair, I do not plan on supporting web, android or iOS yet (as it isnt even completed with the basic idea). Maybe I will...?
+
+## Contributions
+
+Yeah yeah, go ahead and contribute. Make sure it works, and its not spam, and any tests pass.
diff --git a/eucalyptus/Cargo.toml b/eucalyptus/Cargo.toml
index ab68cc1..27fc788 100644

Large diffs are not rendered by default. Showing the first 50 of 74 lines. Show full diff