Updated documentation
This commit is contained in:
25
README.md
25
README.md
@@ -1,11 +1,24 @@
|
||||
# protostar
|
||||
A collection of application launchers for Stardust XR
|
||||
> [!IMPORTANT]
|
||||
> Requires the [Stardust XR Server](https://github.com/StardustXR/server) to be running. For launching 2D applications, [Flatland](https://github.com/StardustXR/flatland) also needs to be running.
|
||||
|
||||
Prototype application launcher for Stardust XR
|
||||
If you installed the Stardust XR server via:
|
||||
```note
|
||||
sudo dnf group install stardust-xr
|
||||
```
|
||||
Or if you installed via the [installation script](https://github.com/cyberneticmelon/usefulscripts/blob/main/stardustxr_setup.sh), Protostar comes pre-installed
|
||||
|
||||
Protostar provides an easy to use crate to write applications launchers. See the [examples](examples) to learn more!
|
||||
# How to Use
|
||||
Protostar itself can be used to build various kinds of app launchers, but two are built in. Most likely the one you will want to use will be `hexagon_launcher`. After launching, in flastcreen mode drag applications out of the app launcher, hold down `Shift + ~`
|
||||

|
||||
**Quest 3 Hand tracking**:
|
||||
Pinch to drag and drop, grasp with full hand for grabbing, point and click with pointer finger to click or pinch from a distance
|
||||
|
||||
# TODO:
|
||||

|
||||
|
||||
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
|
||||
## Manual Installation
|
||||
Clone the repository and after the server is running:
|
||||
```sh
|
||||
cargo run
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user