Skip to content

Commit 691e9b5

Browse files
Add README.adoc and ROADMAP.adoc for project specification (#2)
Repo currently contains infrastructure (multi-forge mirroring, instant sync) and language policy, with scripts pending upload. Documents reflect this state honestly with clear roadmap for implementation phases. Co-authored-by: Claude <noreply@anthropic.com>
1 parent 1bbbc91 commit 691e9b5

File tree

2 files changed

+181
-0
lines changed

2 files changed

+181
-0
lines changed

README.adoc

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
// SPDX-License-Identifier: AGPL-3.0-or-later
2+
= Hyperpolymath Scripts
3+
:toc: macro
4+
:toclevels: 2
5+
:icons: font
6+
7+
Personal scripts and automation tools following the Hyperpolymath Standard.
8+
9+
toc::[]
10+
11+
== Status
12+
13+
[IMPORTANT]
14+
====
15+
**Repo project specification** - scripts will be uploaded shortly.
16+
17+
Infrastructure and policies are in place; script implementations pending.
18+
====
19+
20+
== Planned Scripts
21+
22+
[cols="1,3", options="header"]
23+
|===
24+
|Script |Purpose
25+
26+
|`asdfman.sh`
27+
|Manage asdf plugins and versions
28+
29+
|`init_bashrc_three_ply.sh`
30+
|Modular bashrc setup (three-layer architecture)
31+
32+
|`k-check.sh`
33+
|Kinoite cluster validation
34+
35+
|`k-intune.sh`
36+
|Kinoite tuning scripts
37+
38+
|`langstrap.sh`
39+
|Mass language install utilities
40+
41+
|`sysenv.sh`
42+
|System environment setup
43+
44+
|`touchscreen_hunter_killer.sh`
45+
|Touchscreen calibration/management
46+
|===
47+
48+
== Infrastructure
49+
50+
=== Multi-Forge Mirroring
51+
52+
This repository uses a hub-and-spoke model with GitHub as the hub:
53+
54+
* **GitLab** - `gitlab.com/hyperpolymath/scripts`
55+
* **Codeberg** - `codeberg.org/hyperpolymath/scripts`
56+
* **Bitbucket** - `bitbucket.org/hyperpolymath/scripts`
57+
58+
Features:
59+
60+
* SSH host key verification (MITM protection)
61+
* SHA-pinned action dependencies
62+
* Instant sync on push/release via `.git-private-farm` dispatch
63+
64+
=== Security Hardening
65+
66+
* Ed25519 SSH keys only
67+
* Principle of least privilege (`contents: read`)
68+
* No dynamic host key acceptance
69+
70+
== Language Policy
71+
72+
This repo follows the **Hyperpolymath Standard** (see `.claude/CLAUDE.md`):
73+
74+
[cols="1,2", options="header"]
75+
|===
76+
|Allowed |Use Case
77+
78+
|Bash/POSIX Shell
79+
|Scripts, automation
80+
81+
|Rust
82+
|Performance-critical tools, CLI
83+
84+
|ReScript
85+
|Application code (compiles to JS)
86+
87+
|Deno
88+
|JS runtime (replaces Node)
89+
90+
|Gleam
91+
|Backend services
92+
93+
|Guile Scheme
94+
|State/meta files
95+
|===
96+
97+
[cols="1,1", options="header"]
98+
|===
99+
|Banned |Replacement
100+
101+
|TypeScript |ReScript
102+
|Node.js/npm |Deno
103+
|Go |Rust
104+
|Python (general) |Rust/ReScript
105+
|===
106+
107+
== Usage
108+
109+
[source,bash]
110+
----
111+
# Clone from any forge
112+
git clone git@gitlab.com:hyperpolymath/scripts.git
113+
git clone git@codeberg.org:hyperpolymath/scripts.git
114+
git clone git@github.com:hyperpolymath/scripts.git
115+
----
116+
117+
== License
118+
119+
AGPL-3.0-or-later

ROADMAP.adoc

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// SPDX-License-Identifier: AGPL-3.0-or-later
2+
= Roadmap
3+
:icons: font
4+
5+
== Current State
6+
7+
[cols="1,1,3", options="header"]
8+
|===
9+
|Component |Status |Notes
10+
11+
|Multi-forge mirroring
12+
|icon:check-circle[role="green"] Done
13+
|GitHub → GitLab/Codeberg/Bitbucket
14+
15+
|Instant sync dispatch
16+
|icon:check-circle[role="green"] Done
17+
|Triggers `.git-private-farm` propagation
18+
19+
|SSH hardening
20+
|icon:check-circle[role="green"] Done
21+
|Ed25519 host keys, pinned actions
22+
23+
|Language policy
24+
|icon:check-circle[role="green"] Done
25+
|Hyperpolymath Standard defined
26+
27+
|Script implementations
28+
|icon:clock[role="orange"] Pending
29+
|All 7 scripts to be uploaded
30+
|===
31+
32+
== Phase 1: Core Scripts
33+
34+
[%interactive]
35+
* [ ] `sysenv.sh` - System environment bootstrap
36+
* [ ] `langstrap.sh` - Language toolchain installer
37+
* [ ] `asdfman.sh` - asdf version manager helper
38+
39+
== Phase 2: Shell Configuration
40+
41+
[%interactive]
42+
* [ ] `init_bashrc_three_ply.sh` - Modular bashrc
43+
** Layer 1: Core aliases/functions
44+
** Layer 2: Environment-specific
45+
** Layer 3: Machine-local overrides
46+
47+
== Phase 3: Fedora Kinoite Tools
48+
49+
[%interactive]
50+
* [ ] `k-check.sh` - Cluster validation
51+
* [ ] `k-intune.sh` - Tuning automation
52+
53+
== Phase 4: Hardware Utilities
54+
55+
[%interactive]
56+
* [ ] `touchscreen_hunter_killer.sh` - Touchscreen management
57+
58+
== Future Considerations
59+
60+
* Rust rewrites for performance-critical scripts
61+
* Guix/Nix packaging (`guix.scm`, `flake.nix`)
62+
* Integration with broader Hyperpolymath ecosystem

0 commit comments

Comments
 (0)