Skip to content

Commit ca3d15e

Browse files
committed
Move examples
1 parent a5b9011 commit ca3d15e

37 files changed

+23
-270
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
/target/
88
*.user
99
/.direnv/
10-
/examples/calculator-rs/calculator-cs/obj
11-
/examples/calculator-rs/calculator-cs/bin
10+
/feather-ui/examples/calculator-rs/calculator-cs/obj
11+
/feather-ui/examples/calculator-rs/calculator-cs/bin
1212
.rustfmt.toml

Cargo.lock

Lines changed: 5 additions & 68 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,13 @@
44
[workspace]
55
members = [
66
"feather-ui",
7-
"examples/basic-rs",
8-
"examples/basic-alc",
9-
"examples/paragraph-rs",
10-
"examples/calculator-rs",
11-
# "examples/calculator-alc", # This breaks cargo for some reason
12-
"examples/graph-rs",
13-
"examples/grid-rs",
14-
"examples/list-rs",
15-
"examples/textbox-rs",
7+
"feather-ui/examples/basic-alc",
8+
"feather-ui/examples/calculator-rs",
9+
# "feather-ui/examples/calculator-alc", # This breaks cargo for some reason
1610
"feather-macro",
1711
]
1812
resolver = "2"
19-
default-members = [
20-
"feather-ui",
21-
"examples/basic-rs",
22-
"examples/paragraph-rs",
23-
"examples/graph-rs",
24-
"examples/list-rs",
25-
"examples/grid-rs",
26-
"feather-macro",
27-
]
13+
default-members = ["feather-ui", "feather-macro"]
2814

2915
[workspace.package]
3016
version = "0.2.0"

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
# Feather UI
22

3-
Feather is a universal UI library that applies user inputs to application state, and maps application state to an interactive visualization using a custom graphics rendering language capable of compiling to arbitrary GPU code or vectorized CPU code.
4-
5-
This project is currently in a prototyping stage, it is not yet suitable for production, and not all planned features are implemented.
3+
Feather is a universal UI library that only mutates application state in response to user inputs or events, using functional reactive event streams, and maps application state to a layout using persistent functions, which then efficiently render only the parts of the UI that changed using either a standard GPU compositor or custom shaders.
64

75
## Building
86

97
Feather is a standard rust project, simply run `cargo build` on your platform of choice. A NixOS flake is included that provides a develop environment for nix developers who do not have rust installed system-wide.
108

119
## Running
1210

13-
Two working examples are available: `basic-rs` and `paragraph-rs`. To run either, navigate into the folder and run `cargo run`.
11+
Examples can be found in `feather-ui/examples`, and can be run via `cargo run --example [example_name]`.
1412

15-
If you are on NixOS, use `nix run github:Fundament-Software/feathergui#basic-rs` or `nix run github:Fundament-Software/feathergui#paragraph-rs`
16-
If you are not on nixos but have nix, use `nix run --impure github:nix-community/nixGL -- nix run github:fundament-software/feathergui#basic-rs`
17-
If you do not have nix, you must navigate into the relevant example folder and run `cargo run`
13+
If you are on NixOS, use `nix run github:Fundament-Software/feathergui#[example_name]`
14+
If you are not on nixos but have nix, use `nix run --impure github:nix-community/nixGL -- nix run github:fundament-software/feathergui#[example_name]`
1815

1916
The examples have currently only been tested on NixOS and Windows 11, but should work on most systems.
2017

REUSE.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SPDX-License-Identifier = "Apache-2.0"
1111

1212

1313
[[annotations]]
14-
path = "examples/calculator-rs/calculator-cs/**"
14+
path = "feather-ui/examples/calculator-rs/calculator-cs/**"
1515
precedence = "aggregate"
1616
SPDX-FileCopyrightText = "2025 Fundament Software SPC <https://fundament.software>"
1717
SPDX-License-Identifier = "Apache-2.0"

examples/basic-rs/Cargo.toml

Lines changed: 0 additions & 23 deletions
This file was deleted.

examples/graph-rs/Cargo.toml

Lines changed: 0 additions & 23 deletions
This file was deleted.

examples/grid-rs/Cargo.toml

Lines changed: 0 additions & 28 deletions
This file was deleted.

examples/list-rs/Cargo.toml

Lines changed: 0 additions & 23 deletions
This file was deleted.

examples/paragraph-rs/Cargo.toml

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)