WIP: Canary example network application

@@ -0,0 +3,4 @@
+
+Canary's current maintainer and benevolent dictator for life [2] is Marceline
+Cramer (<cramermarceline@gmail.com>, <mars@tebibyte.media>, GitHub:
+@marceline-cramer, Discord: @CrazyWazy#5915).

@@ -0,0 +5,4 @@
+Cramer (<cramermarceline@gmail.com>, <mars@tebibyte.media>, GitHub:
+@marceline-cramer, Discord: @CrazyWazy#5915).
+
+Modern GUI frameworks (such as Qt) typically work with the backend application

@@ -0,0 +11,4 @@
+application uses that GUI functionality like a traditional library. This
+frame of design philosophy creates large, heavily centralized GUI systems.
+Complex application interfaces are now only available through a limited number
+of existing GUI frameworks, and as more applications become reliant on these

@@ -0,0 +12,4 @@
+frame of design philosophy creates large, heavily centralized GUI systems.
+Complex application interfaces are now only available through a limited number
+of existing GUI frameworks, and as more applications become reliant on these
+frameworks, the frameworks are forced to accumulate even more features and

@@ -0,0 +21,4 @@
+application logic and frontend logic and relocating complex GUI code from a
+static native library to a modular scriptable runtime that can be customized
+by the user. Applications communicate with Canary scripts through
+informally-standardized protocols of messages, and the scripts provide the

@@ -0,0 +22,4 @@
+static native library to a modular scriptable runtime that can be customized
+by the user. Applications communicate with Canary scripts through
+informally-standardized protocols of messages, and the scripts provide the
+layout and rendering. Custom scripts implementing the same protocols can then be

@@ -0,0 +23,4 @@
+by the user. Applications communicate with Canary scripts through
+informally-standardized protocols of messages, and the scripts provide the
+layout and rendering. Custom scripts implementing the same protocols can then be
+provided by the user, which style, personalize, and enhance Canary GUIs without

@@ -0,0 +27,4 @@
+the need to recompile the target application or integrate with an upstream
+framework.
+
+To see why this model of GUI design is so innovative, imagine a stereotypical

@@ -0,0 +28,4 @@
+framework.
+
+To see why this model of GUI design is so innovative, imagine a stereotypical
+video game. This game has a health meter for the player that has a certain

@@ -0,0 +31,4 @@
+video game. This game has a health meter for the player that has a certain
+capacity and value. During the course of the game, that meter may be depleted
+when the player takes damage, filled when the player uses a healing item, or
+have its capacity increase when the player levels up. With Canary, the game

@@ -0,0 +34,4 @@
+have its capacity increase when the player levels up. With Canary, the game
+would group these events and give them a name, like "simplehealthmeter". Then,
+the game would ship with a Canary script that implements the "simplehealthmeter"
+protocol and renders a basic red bar on the screen for the player's health while

@@ -0,0 +36,4 @@
+the game would ship with a Canary script that implements the "simplehealthmeter"
+protocol and renders a basic red bar on the screen for the player's health while
+updating the position of the bar based on those events. The player can then
+provide their own script implementing the "simplehealthmeter" that renders a red

@@ -0,0 +39,4 @@
+provide their own script implementing the "simplehealthmeter" that renders a red
+dial instead, or a Zelda-style hearts meter, or anything they want. Then, when
+they show off their new customization and upload their script online, other
+players can use the new script for their health meter too.

@@ -0,0 +41,4 @@
+they show off their new customization and upload their script online, other
+players can use the new script for their health meter too.
+
+Canary makes no assumptions about what the contents of your user interface may

@@ -0,0 +44,4 @@
+Canary makes no assumptions about what the contents of your user interface may
+be. It doesn't come with preset structures like "views," "containers," or even
+"widgets." Canary operates on the principle that you, the user, are the only
+person capable of structuring your computer's GUI, to your arbitrary,

@@ -0,0 +53,4 @@
+There is a very large pool of developers available who would be interested in a
+system like Canary. Online communities such as Reddit's r/unixporn are filled
+with thousands of users who stylize and personalize their software's GUIs for
+fun. Canary, as a maximally-hackable GUI framework, would have a lot of appeal

@@ -0,0 +54,4 @@
+system like Canary. Online communities such as Reddit's r/unixporn are filled
+with thousands of users who stylize and personalize their software's GUIs for
+fun. Canary, as a maximally-hackable GUI framework, would have a lot of appeal
+to these kinds of people. A big advantage that hackable GUI has to other kinds

@@ -0,0 +57,4 @@
+to these kinds of people. A big advantage that hackable GUI has to other kinds
+of hackable software is that changes to it are immediately apparent to anyone
+looking at it. Canary's plan for adoption is to post some initial demonstrations
+and functional Canary programs on image-oriented social media like r/unixporn.

@@ -0,0 +63,4 @@
+others to establish a functioning ecosystem of Canary scripts and regular
+contributors.
+
+Canary would make a good project to be accepted to Tebibyte Media because its

@@ -0,0 +64,4 @@
+contributors.
+
+Canary would make a good project to be accepted to Tebibyte Media because its
+post-structuralist nature of making no assumptions about the user's needs and

@@ -0,0 +66,4 @@
+Canary would make a good project to be accepted to Tebibyte Media because its
+post-structuralist nature of making no assumptions about the user's needs and
+its reliance on communal content creation matches Tebibyte Media's goals to
+network users together towards similar ends. Other free software projects on

@@ -0,0 +67,4 @@
+post-structuralist nature of making no assumptions about the user's needs and
+its reliance on communal content creation matches Tebibyte Media's goals to
+network users together towards similar ends. Other free software projects on
+Tebibyte Media can use Canary for their GUI and convene with other network

@@ -0,0 +76,4 @@
+network users together towards similar ends. Other Network members could use
+Canary for their GUI and have an active community of Canary developers with whom
+projects can share scripts with.
+

@@ -0,0 +77,4 @@
+Canary for their GUI and have an active community of Canary developers with whom
+projects can share scripts with.
+
+Canary is designed to be easy to develop alternative runtimes for, because its

@@ -0,0 +89,4 @@
+shall be left open to develop a Canary runtime for web browsers, the web runtime
+must require a different design architecture from its native counterpart and is
+low priority. Canary's first target use case is to replace customizable desktop
+widget apps with Canary-enabled apps. These may be wallpapers apps like

@@ -0,0 +96,4 @@
+
+Virtual reality is also a primary target for Canary; the current VR ecosystem
+is in desperate need of better GUIs and more free software alternatives. Canary
+was originally conceived to fill both of these needs. Thus, VR-capable 3D game

@@ -0,0 +97,4 @@
+Virtual reality is also a primary target for Canary; the current VR ecosystem
+is in desperate need of better GUIs and more free software alternatives. Canary
+was originally conceived to fill both of these needs. Thus, VR-capable 3D game
+engines such as Unity, StereoKit, and Bevy are considered first-class priority

@@ -0,0 +105,4 @@
+MIT (aka Expat) or Apache-2.0. Both the LGPLv3 and permissive licenses allow
+works to be linked to proprietary software, such as Unreal Engine and the Unity
+game engine. The LGPLv3, however, requires that the work be linked to
+proprietary software as a shared library. This shared library must provide to

@@ -0,0 +112,4 @@
+If a third party distributes a shared library compiled from a modified copy of
+an LGPLv3-licensed work, they must supply the modified source code to their
+users. This prevents malicious parties from creating a custom canary-rs runtime
+that is only useable with their applications. For more info, see Microsoft's

@@ -0,0 +113,4 @@
+an LGPLv3-licensed work, they must supply the modified source code to their
+users. This prevents malicious parties from creating a custom canary-rs runtime
+that is only useable with their applications. For more info, see Microsoft's
+strategy to "Embrace, Extend, and Extinguish" other companies' software

@@ -0,0 +116,4 @@
+strategy to "Embrace, Extend, and Extinguish" other companies' software
+projects [3].
+
+The selection of a copyleft license allows for canary-rs to be used alongside

@@ -0,0 +127,4 @@
+possible. Few game developers who are unfamiliar with free software will choose
+to take on the responsibilities that a non-Lesser GPL requires, no matter what
+features Canary offers. The LGPL's slightly more liberal requirements will be
+essential to Canary's adoption outside of the free software evangelist space.

@@ -0,0 +16,4 @@
+programming, and neuters variety and creativity.
+
+Canary inverts this hierarchy by cutting the GUI Gordian knot between
+application logic and frontend logic and relocating complex GUI code from a

@@ -0,0 +17,4 @@
+
+Canary inverts this hierarchy by cutting the GUI Gordian knot between
+application logic and frontend logic and relocating complex GUI code from a
+static native library to a modular scriptable runtime that can be customized

@@ -0,0 +19,4 @@
+application logic and frontend logic and relocating complex GUI code from a
+static native library to a modular scriptable runtime that can be customized
+by the user. Applications communicate with Canary scripts through
+informally-standardized protocols, and the scripts provide the layout, input

@@ -0,0 +25,4 @@
+This lifts the burden for the user of recompiling the target application or
+integrating their changes into a larger upstream framework.
+
+To understand the innovation of this design, imagine a stereotypical video game.

@@ -0,0 +26,4 @@
+integrating their changes into a larger upstream framework.
+
+To understand the innovation of this design, imagine a stereotypical video game.
+Let's say that this game has a health meter for the player that has a certain

@@ -0,0 +29,4 @@
+Let's say that this game has a health meter for the player that has a certain
+capacity and value. During the course of the game, that meter may be depleted
+when the player takes damage, filled when the player uses a healing item, or
+have its capacity increased when the player levels up. With Canary, the game

@@ -0,0 +36,4 @@
+player's health while updating the position of the bar based on those events.
+The player can then replace the provided script with their own
+"simplehealthmeter" that renders a red dial instead, or a Zelda-style hearts
+meter, or anything they want. Then, when they show off their new customization

@@ -0,0 +61,4 @@
+garnered from these GUI-customizing users, Canary's developers will use the
+customizations and the scripts they write and share with others to establish a
+functioning ecosystem of Canary scripts and regular contributors.
+

@@ -0,0 +75,4 @@
+Network members could use Canary for their GUIs and have an active community of
+Canary developers with whom projects can share scripts with.
+
+Canary is designed to be easy to develop alternative runtimes for, because its