From cc3eae7600e5be2d2c016e323c7a30235b6b5d49 Mon Sep 17 00:00:00 2001 From: Nicola Guerrera Date: Sun, 14 May 2023 15:40:24 +0200 Subject: [PATCH] Added example readme --- README.md | 16 ++++++---------- examples/README.md | 8 ++++++++ 2 files changed, 14 insertions(+), 10 deletions(-) create mode 100644 examples/README.md diff --git a/README.md b/README.md index d811646..256d93e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,11 @@ # protostar -Prototype application launcher +Prototype application launcher for StardustXR -TODO: +Protostar provides an easy to use crate to write applications launchers. See the [examples](examples) to learn more! -1) ~~Make it work with all icons (should be done)~~ +# TODO: -2. ~~If the right sized png exists, then use that, otherwise rasterize it (a bit janky but it works)~~ -3. ~~Use XDG_CACHE_DIR to rasterize svgs (done)~~ -4. Make sure it's using the current icon theme -5. Design a better app launcher ui - -TO RUN DOCK -cargo run --example sirius +1. Implement our own (more reliable) way to get icons +2. Untangle the code (eg: make it so that the user can decide sizes, models, etc... ) +3. Implement [configuration files](https://docs.rs/confy/latest/confy/) in the examples \ No newline at end of file diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..087c2b8 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,8 @@ +# Running the examples: + +``` +cargo run --example=sirius +cargo run --example=app_grid +cargo run --example=hexagon_launcher + +``` \ No newline at end of file