Skip to content

Commit 46877a1

Browse files
committed
Update README and fix tests
1 parent 4a9f419 commit 46877a1

2 files changed

Lines changed: 83 additions & 6 deletions

File tree

README.md

Lines changed: 81 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,56 @@
33
> Cloud-native development environment with vim keybindings
44
55
[![Build](https://github.com/binarypie-dev/hypercube/actions/workflows/build.yml/badge.svg)](https://github.com/binarypie-dev/hypercube/actions/workflows/build.yml)
6+
[![nvim-dev](https://github.com/binarypie-dev/hypercube/actions/workflows/build-nvim-dev.yml/badge.svg)](https://github.com/binarypie-dev/hypercube/actions/workflows/build-nvim-dev.yml)
7+
[![Copr](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/datacube/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/)
68
[![GHCR](https://img.shields.io/badge/GHCR-ghcr.io%2Fbinarypie--dev%2Fhypercube-blue)](https://ghcr.io/binarypie-dev/hypercube)
79

10+
<details>
11+
<summary><strong>COPR Package Build Status</strong></summary>
12+
13+
#### Hyprland Core Libraries
14+
| Package | Status |
15+
|---------|--------|
16+
| hyprutils | [![hyprutils](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprutils/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprutils/) |
17+
| hyprlang | [![hyprlang](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprlang/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprlang/) |
18+
| hyprwayland-scanner | [![hyprwayland-scanner](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprwayland-scanner/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprwayland-scanner/) |
19+
| hyprgraphics | [![hyprgraphics](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprgraphics/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprgraphics/) |
20+
| hyprcursor | [![hyprcursor](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprcursor/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprcursor/) |
21+
| hyprland-protocols | [![hyprland-protocols](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-protocols/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-protocols/) |
22+
| aquamarine | [![aquamarine](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/aquamarine/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/aquamarine/) |
23+
| hyprland-qt-support | [![hyprland-qt-support](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-qt-support/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-qt-support/) |
24+
| glaze | [![glaze](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/glaze/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/glaze/) |
25+
26+
#### Hyprland Compositor & Tools
27+
| Package | Status |
28+
|---------|--------|
29+
| hyprland | [![hyprland](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland/) |
30+
| hyprlock | [![hyprlock](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprlock/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprlock/) |
31+
| hypridle | [![hypridle](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hypridle/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hypridle/) |
32+
| hyprpaper | [![hyprpaper](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprpaper/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprpaper/) |
33+
| xdg-desktop-portal-hyprland | [![xdg-desktop-portal-hyprland](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/xdg-desktop-portal-hyprland/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/xdg-desktop-portal-hyprland/) |
34+
| hyprpolkitagent | [![hyprpolkitagent](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprpolkitagent/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprpolkitagent/) |
35+
| hyprtoolkit | [![hyprtoolkit](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprtoolkit/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprtoolkit/) |
36+
| hyprland-guiutils | [![hyprland-guiutils](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-guiutils/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/hyprland-guiutils/) |
37+
| uwsm | [![uwsm](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/uwsm/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/uwsm/) |
38+
39+
#### CLI Tools
40+
| Package | Status |
41+
|---------|--------|
42+
| eza | [![eza](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/eza/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/eza/) |
43+
| starship | [![starship](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/starship/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/starship/) |
44+
| lazygit | [![lazygit](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/lazygit/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/lazygit/) |
45+
| wifitui | [![wifitui](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/wifitui/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/wifitui/) |
46+
47+
#### Other
48+
| Package | Status |
49+
|---------|--------|
50+
| quickshell | [![quickshell](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/quickshell/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/quickshell/) |
51+
| regreet | [![regreet](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/regreet/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/regreet/) |
52+
| livesys-scripts | [![livesys-scripts](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/livesys-scripts/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/binarypie/hypercube/package/livesys-scripts/) |
53+
54+
</details>
55+
856
Hypercube is an opinionated, ready-to-use development environment built on [Universal Blue's base-main](https://github.com/ublue-os/main) image with Fedora 43. It provides a complete Hyprland-based workflow with consistent vim keybindings across all tools and Tokyo Night theming throughout.
957

1058
## Features
@@ -58,15 +106,22 @@ Tokyo Night color scheme everywhere:
58106

59107
### Prerequisites
60108

61-
- A system running a bootc-compatible image (Bazzite, Bluefin, Aurora, or Fedora Atomic)
62-
- Basic familiarity with container-based operating systems
109+
- A system running Fedora Atomic (Silverblue, Kinoite, Bazzite, Bluefin, Aurora, etc.)
110+
- Basic familiarity with image-based operating systems
63111

64112
### Switch to Hypercube
65113

66-
From your existing bootc system:
114+
From your existing Fedora Atomic system:
115+
116+
```bash
117+
rpm-ostree rebase ostree-unverified-registry:ghcr.io/binarypie-dev/hypercube:43
118+
systemctl reboot
119+
```
120+
121+
After the first reboot, you can switch to signed images for additional security:
67122

68123
```bash
69-
sudo bootc switch ghcr.io/binarypie-dev/hypercube:43
124+
rpm-ostree rebase ostree-image-signed:docker://ghcr.io/binarypie-dev/hypercube:43
70125
systemctl reboot
71126
```
72127

@@ -79,10 +134,31 @@ Bootable ISOs are available from the [GitHub Releases](https://github.com/binary
79134
### Switching Back
80135

81136
```bash
82-
sudo bootc switch <your-previous-image>
137+
rpm-ostree rebase <your-previous-image>
83138
systemctl reboot
84139
```
85140

141+
### Resetting Configuration
142+
143+
Hypercube ships default configurations in `/usr/share/hypercube/config/`. If you've modified your `~/.config/` files and want to reset to defaults:
144+
145+
```bash
146+
# Reset a specific app's config (e.g., hyprland)
147+
rm -rf ~/.config/hypr
148+
cp -r /usr/share/hypercube/config/hypr ~/.config/
149+
150+
# Or reset all Hypercube configs
151+
rm -rf ~/.config/{hypr,fish,starship.toml,ghostty,nvim}
152+
cp -r /usr/share/hypercube/config/* ~/.config/
153+
```
154+
155+
To see what the default configuration looks like without overwriting your files:
156+
157+
```bash
158+
ls /usr/share/hypercube/config/
159+
diff -r ~/.config/hypr /usr/share/hypercube/config/hypr
160+
```
161+
86162
## What's Included
87163

88164
### Packages

build_files/hypercube/99-tests.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ REQUIRED_FILES=(
5656
"/usr/share/backgrounds/hypercube/background.png"
5757
# DX config
5858
"/etc/distrobox/distrobox.ini"
59-
"/usr/share/ublue-os/just/61-dx.just"
59+
"/usr/share/ublue-os/just/60-hypercube.just"
60+
"/usr/share/ublue-os/just/61-nvim.just"
6061
)
6162

6263
for file in "${REQUIRED_FILES[@]}"; do

0 commit comments

Comments
 (0)