Let the wizardry begin

.editorconfig

@@ -0,0 +1,53 @@
+# EditorConfig configuration for this repository -- https://EditorConfig.org
+
+# Top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file, utf-8 charset
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+# Ignore diffs/patches
+[*.{diff,patch}]
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+
+# Prefer space-indent for..
+[*.{json,lock,md,pl,pm,py,rb,xml}]
+indent_style = space
+
+# Prefer tab-indent for..
+[*.{nix,sh,bash}]
+indent_style = tab
+
+[*.{json,lock,md,nix,rb,sh}]
+indent_size = 2
+
+[*.lock]
+indent_size = unset
+
+[*.md]
+trim_trailing_whitespace = true
+
+# binaries
+[*.nib]
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+charset = unset
+
+[eggs.nix]
+trim_trailing_whitespace = unset
+
+# You can add file-specific configuration using:
+#
+# [path/to/file]
+# end_of_line = unset
+# indent_style = unset
+# insert_final_newline = unset
+# trim_trailing_whitespace = unset
+# other config..

.envrc

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+# shellcheck shell=sh # POSIX
+
+# This file is used to provide directory-oriented environment variables and integrations
+
+use flake . -v

.gitignore

@@ -0,0 +1 @@
+.direnv/

.shellcheckrc

@@ -0,0 +1,28 @@
+shell=ksh # Enforce POSIX sh
+
+external-sources=true
+
+disable=SC2310 # False Positive, report to upstream
+
+# # Disabled this check as we are using busybox sh which can do these
+# disable=SC3060 # In POSIX sh, string replacement is undefined.
+# disable=SC3057 # In POSIX sh, string indexing is undefined.
+# disable=SC3001 # In POSIX sh, process substitution is undefined.
+
+# name:    avoid-nullary-conditions
+# desc:    Suggest explicitly using -n in `[ $var ]`
+# example: [ "$var" ]
+# fix:     [ -n "$var" ]
+enable=avoid-nullary-conditions
+
+# name:    check-extra-masked-returns
+# desc:    Check for additional cases where exit codes are masked
+# example: rm -r "$(get_chroot_dir)/home"
+# fix:     set -e; dir="$(get_chroot_dir)"; rm -r "$dir/home"
+enable=check-extra-masked-returns
+
+# name:    check-set-e-suppressed
+# desc:    Notify when set -e is suppressed during function invocation
+# example: set -e; func() { cp *.txt ~/backup; rm *.txt; }; func && echo ok
+# fix:     set -e; func() { cp *.txt ~/backup; rm *.txt; }; func; echo ok
+enable=check-set-e-suppressed

README.md

@@ -1 +1,40 @@
-There will be freedom..
+# FreeXR OS
+
+AOSP Pseudo-ROM for QFPROM-fused standalone XR devices to hijack the control over your device back to your hands.
+
+## Features
+
+Global:
+  * Debloater - Removes all software, but those needed for minimal UI functionality
+  * Liberator - Replaces proprietary applications with open-source alternatives
+  * Rebrander[WIP] - Replaces the vendor's branding with a custom one
+
+Device-Specific:
+  * Vendor/Meta:
+    * Disable Firmware Updates
+    * Disables Telemetry[WIP]
+    * Enables META Store with anonymization mitigations
+  * Eureka:
+    * Attempts permanently root of the Device via Event Horizon
+    * Force-Enables Hand Tracking
+  * Panther
+    * Attempts permanently root of the Device via Event Horizon
+    * Force-Enables Hand Tracking
+
+# Contributions
+
+The project is currently under heavy development code improvements are always welcome, but new features have to be brainstormed to be mergable.
+
+The nix daemon is recommended to interface with the repository.
+
+## Tree
+
+├── **docs** -- Various documents for the source code<br/>
+├── **src** -- The Source Code<br/>
+&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── **lib** -- Shell Libraries used by the program<br/>
+&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── **standalone** -- Standalone scripts that can be sourced as libraries<br/>
+├── **tasks** -- Routines to work with the project<br/>
+&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── **docs** -- Tasks related to the project documentation<br/>
+&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── **tree** -- Task used to generate this file hierarchy output<br/>
+&nbsp;|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;├── **editors** -- Nix definition for repository-standardized editors<br/>
+├── **vendor** -- Files from 3rd party used in the project<br/>

default.code-workspace

@@ -0,0 +1,196 @@
+{
+	"folders": [
+		{ "path": "." },
+	],
+
+	"settings": {
+		// Enable liguratures
+		"editor.fontLigatures": true,
+		"editor.fontFamily": "'Fira Code'",
+		"terminal.integrated.fontFamily": "'Fira Code'",
+
+		"editor.renderWhitespace": "all",
+		"terminal.integrated.scrollback": 20000,
+		"nix.enableLanguageServer": true,
+		"nix.serverPath": "nil",
+		"nix.serverSettings": {
+			// settings for 'nil' Language Server
+			"nil": {
+				"formatting": {
+					"command": ["nixpkgs-fmt"]
+				}
+			}
+		},
+		"editor.wordWrap": "on", // Enforce word-wrapped coding style
+		"terminal.integrated.defaultProfile.linux": "bash", // Use bash by default
+		"terminal.integrated.env.linux": {
+			"EDITOR": "nano", // To open git things in codium
+		},
+
+		// Pair colorization
+		"editor.bracketPairColorization.enabled": true,
+		"editor.guides.bracketPairs": "active",
+		"editor.guides.bracketPairsHorizontal": "active",
+		"editor.guides.highlightActiveIndentation": false,
+
+		// Gtt
+		"git.autofetch": true,
+
+		// Code-eol
+		"code-eol.highlightExtraWhitespace": true,
+		"code-eol.newlineCharacter": "↵",
+		"code-eol.crlfCharacter": "↓",
+
+		// Task tree
+		"todo-tree.general.tags": [
+			"FIXME",
+			"TODO",
+			"DOCS",
+			"HACK",
+			"REVIEW",
+			"DNM", // Do Not Merge
+			"DNC", // Do Not Contribute
+			"DNR" // Do Not Release
+		],
+		"todo-tree.regex.regex": "($TAGS)((\\-.*|)\\(.*\\)):", // ($TAGS)((\\-.*|)\\(.*\\)):
+		"todo-tree.filtering.excludeGlobs": [
+			"**/node_modules",
+			"**/README.md"
+		],
+		"todo-tree.tree.groupedByTag": false,
+		"todo-tree.tree.groupedBySubTag": false,
+		"todo-tree.tree.flat": true,
+		// NOTE: Icons has to be valid octicon (https://primer.style/foundations/icons/)
+		"todo-tree.highlights.customHighlight": {
+			// FIXME(Krey): Test
+			"FIXME": {
+				"foreground": "#ff8000",
+				"icon": "tag",
+				"fontWeight": "bold"
+			},
+			// TODO(Krey): Test
+			"TODO": {
+				"foreground": "#00ffea",
+				"icon": "tasklist",
+				"fontWeight": "bold"
+			},
+			// DOCS(Krey): Test
+			"DOCS": {
+				"foreground": "#ffffff",
+				"background": "#2f00ff",
+				"icon": "repo",
+				"fontWeight": "bold"
+			},
+			// HACK(Krey): Test
+			"HACK": {
+				"foreground": "#ffffff",
+				"background": "#ff4d00",
+				"icon": "repo",
+				"fontWeight": "bold"
+			},
+			// REVIEW(Krey): Test
+			"REVIEW": {
+				"foreground": "#ffffff",
+				"background": "#b300ff",
+				"icon": "code-review",
+				"fontWeight": "bold"
+			},
+			// DNM(Krey): Test
+			"DNM": {
+				"background": "#ff0000",
+				"foreground": "#ffffff",
+				"icon": "shield-x",
+				"fontWeight": "bold"
+			},
+			// DNR(Krey): Test
+			"DNR": {
+				"background": "#ff0000",
+				"foreground": "#ffffff",
+				"icon": "shield-x",
+				"fontWeight": "bold"
+			},
+			// DNC(Krey): Test
+			"DNC": {
+				"background": "#fffb00",
+				"foreground": "#000000",
+				"icon": "shield-x",
+				"fontWeight": "bold"
+			}
+		},
+
+		"better-comments.tags": [
+			{
+			"tag": "!",
+			"color": "#FF0000",
+			"strikethrough": false,
+			"underline": false,
+			"backgroundColor": "transparent",
+			"bold": false,
+			"italic": false
+			},
+			{
+				"tag": ":",
+				"color": "#FFAE00",
+				"strikethrough": false,
+				"underline": false,
+				"backgroundColor": "transparent",
+				"bold": false,
+				"italic": false
+			},
+			{
+			"tag": "?",
+			"color": "#3498DB",
+			"strikethrough": false,
+			"underline": false,
+			"backgroundColor": "transparent",
+			"bold": false,
+			"italic": false
+			},
+			{
+			"tag": "//",
+			"color": "#474747",
+			"strikethrough": true,
+			"underline": false,
+			"backgroundColor": "transparent",
+			"bold": false,
+			"italic": false
+			},
+			{
+			"tag": "*",
+			"color": "#98C379",
+			"strikethrough": false,
+			"underline": false,
+			"backgroundColor": "transparent",
+			"bold": false,
+			"italic": false
+			},
+		],
+
+		"dateTime.showSeconds": true,
+
+		// GitLens
+		"gitlens.plusFeatures.enabled": false, // Disable the annoying pop-ups
+		"gitlens.launchpad.indicator.enabled": false, // Disable launchpad indicator as we are not using that functionality
+		"gitlens.statusBar.enabled": false, // Do not bloat the status bar
+		"gitlens.statusBar.pullRequests.enabled": false,
+	},
+
+	"extensions": {
+		"recommendations": [
+			"jnoortheen.nix-ide",
+			"oderwat.indent-rainbow",
+			"arrterian.nix-env-selector",
+			"medo64.render-crlf",
+			"aaron-bond.better-comments",
+			"mkhl.direnv",
+			"editorconfig.editorconfig",
+			"pkief.material-icon-theme",
+			"markwylde.vscode-filesize",
+			"plorefice.devicetree",
+			"timonwong.shellcheck",
+			"eamodio.gitlens",
+			"anwar.resourcemonitor",
+			"gruntfuggly.todo-tree"
+		]
+	}
+}

docs/.about

@@ -0,0 +1 @@
+Various documents for the source code