Skip to content

Commit d638f46

Browse files
claudeclaude
committed
Add README and ROADMAP documenting pre-specification state
- README.adoc: Project placeholder with status, structure, tech stack, and license info - notes specification pending - ROADMAP.adoc: Documents completed infrastructure and awaited items, with placeholder phases for future development
1 parent 35ea696 commit d638f46

2 files changed

Lines changed: 247 additions & 0 deletions

File tree

‎README.adoc‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,93 @@
1+
// SPDX-License-Identifier: MIT OR AGPL-3.0-or-later
2+
// SPDX-FileCopyrightText: 2024-2025 hyperpolymath
13

4+
= SnapCreate
5+
:toc: preamble
6+
:toclevels: 2
7+
:icons: font
8+
9+
*Project specification will be uploaded shortly.*
10+
11+
== Status
12+
13+
[cols="1,3"]
14+
|===
15+
| Phase | Pre-specification
16+
| Code | None yet
17+
| Documentation | Infrastructure templates only
18+
|===
19+
20+
This repository currently contains RSR (Rhodium Standard Repository) infrastructure scaffolding and is awaiting project specification and implementation.
21+
22+
== Repository Structure
23+
24+
The following infrastructure is in place:
25+
26+
[source]
27+
----
28+
snapcreate/
29+
├── .claude/ # AI assistant configuration
30+
├── .github/ # GitHub workflows, templates, funding
31+
│ ├── workflows/ # CI/CD pipelines (CodeQL, quality, security)
32+
│ └── ISSUE_TEMPLATE/
33+
├── docs/ # Documentation
34+
│ └── CITATIONS.adoc
35+
├── justfile # Task runner (RSR standard template)
36+
├── LICENSE.txt # Dual MIT / AGPL-3.0-or-later
37+
├── SECURITY.md # Security policy template
38+
├── CONTRIBUTING.md # Contribution guidelines template
39+
├── CODE_OF_CONDUCT.md
40+
├── STATE.adoc # Project state tracking
41+
└── ROADMAP.adoc # Development roadmap
42+
----
43+
44+
== Technology Stack
45+
46+
Per the Hyperpolymath Standard (see `.claude/CLAUDE.md`):
47+
48+
[cols="1,2"]
49+
|===
50+
| Category | Technology
51+
52+
| Primary Language | ReScript (compiles to JS, type-safe)
53+
| Runtime | Deno (replaces Node/npm/bun)
54+
| Systems/WASM | Rust
55+
| Mobile | Tauri 2.0+ or Dioxus
56+
| Backend | Gleam (BEAM or JS target)
57+
| Package Management | Guix (primary), Nix (fallback), Deno (JS deps)
58+
| Configuration | Nickel
59+
| State/Meta Files | Guile Scheme
60+
|===
61+
62+
== Getting Started
63+
64+
Once the project specification is uploaded:
65+
66+
[source,bash]
67+
----
68+
# Clone
69+
git clone https://github.com/hyperpolymath/snapcreate.git
70+
cd snapcreate
71+
72+
# View available tasks
73+
just
74+
75+
# Enter development shell (when guix.scm/flake.nix is added)
76+
just guix-shell # or: just nix-shell
77+
----
78+
79+
== License
80+
81+
Dual-licensed under link:LICENSE.txt[MIT OR AGPL-3.0-or-later].
82+
83+
Encourages (non-binding) adherence to https://github.com/hyperpolymath/palimpsest-license[Palimpsest License] principles for consent-based digital interaction.
84+
85+
== Contributing
86+
87+
See link:CONTRIBUTING.md[CONTRIBUTING.md] for guidelines.
88+
89+
== See Also
90+
91+
* link:ROADMAP.adoc[Development Roadmap]
92+
* link:docs/CITATIONS.adoc[How to Cite]
93+
* link:SECURITY.md[Security Policy]

‎ROADMAP.adoc‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
// SPDX-License-Identifier: MIT OR AGPL-3.0-or-later
2+
// SPDX-FileCopyrightText: 2024-2025 hyperpolymath
3+
4+
= SnapCreate Roadmap
5+
:toc:
6+
:toclevels: 2
7+
:icons: font
8+
9+
== Current Status
10+
11+
*Phase: Pre-specification*
12+
13+
This project is in the initial scaffolding phase. The repository contains RSR (Rhodium Standard Repository) infrastructure but awaits project specification and implementation.
14+
15+
== Infrastructure Complete
16+
17+
The following foundational elements are in place:
18+
19+
=== Repository Infrastructure
20+
21+
[%header,cols="2,1,2"]
22+
|===
23+
| Component | Status | Notes
24+
25+
| Git repository structure | Done | Standard layout
26+
| License (MIT / AGPL-3.0-or-later) | Done | Dual license with Palimpsest overlay
27+
| EditorConfig | Done | Consistent formatting
28+
| Gitignore / Gitattributes | Done | Standard patterns
29+
|===
30+
31+
=== CI/CD Pipelines
32+
33+
[%header,cols="2,1,2"]
34+
|===
35+
| Workflow | Status | Purpose
36+
37+
| CodeQL Analysis | Done | Security scanning
38+
| Quality checks | Done | Linting, formatting
39+
| Scorecard | Done | Supply chain security
40+
| Security policy enforcement | Done | Dependency auditing
41+
| RSR antipattern detection | Done | Standards compliance
42+
| Guix/Nix policy | Done | Package management validation
43+
| Mirror sync | Done | Multi-forge distribution
44+
|===
45+
46+
=== Documentation Templates
47+
48+
[%header,cols="2,1"]
49+
|===
50+
| Document | Status
51+
52+
| README.adoc | Placeholder ready
53+
| CONTRIBUTING.md | Template (needs customisation)
54+
| SECURITY.md | Template (needs customisation)
55+
| CODE_OF_CONDUCT.md | Done
56+
| CITATIONS.adoc | Done
57+
|===
58+
59+
=== Development Tooling
60+
61+
[%header,cols="2,1,2"]
62+
|===
63+
| Tool | Status | Notes
64+
65+
| Justfile | Done | RSR standard template with TODOs
66+
| Claude AI config (.claude/CLAUDE.md) | Done | Hyperpolymath language policy
67+
|===
68+
69+
== Awaiting Specification
70+
71+
The following require project specification before implementation:
72+
73+
=== Core Project Definition
74+
75+
* [ ] Project purpose and scope
76+
* [ ] Target use cases
77+
* [ ] Feature requirements
78+
* [ ] Architecture decisions (ADRs)
79+
80+
=== Build System
81+
82+
* [ ] guix.scm or flake.nix
83+
* [ ] deno.json (if using ReScript/JS)
84+
* [ ] Cargo.toml (if using Rust)
85+
* [ ] Custom justfile recipes for the project
86+
87+
=== Source Code
88+
89+
* [ ] src/ directory structure
90+
* [ ] Core modules
91+
* [ ] Tests
92+
* [ ] Examples
93+
94+
=== RSR Compliance
95+
96+
* [ ] .well-known/security.txt
97+
* [ ] .well-known/ai.txt
98+
* [ ] .well-known/humans.txt
99+
* [ ] RSR_COMPLIANCE.adoc
100+
* [ ] STATE.scm (Guile Scheme state file)
101+
102+
== Future Phases
103+
104+
[NOTE]
105+
====
106+
The phases below are placeholders. Actual roadmap milestones will be defined once the project specification is uploaded.
107+
====
108+
109+
=== Phase 1: Specification
110+
111+
* Define project scope and requirements
112+
* Document architecture decisions
113+
* Set up development environment
114+
* Establish testing strategy
115+
116+
=== Phase 2: Foundation
117+
118+
* Implement core functionality
119+
* Set up CI/CD for builds
120+
* Write initial tests
121+
* Create minimal documentation
122+
123+
=== Phase 3: Feature Development
124+
125+
* Build out primary features
126+
* Expand test coverage
127+
* Add user documentation
128+
* Community feedback integration
129+
130+
=== Phase 4: Stabilisation
131+
132+
* Performance optimisation
133+
* Security hardening
134+
* Documentation completion
135+
* Release preparation
136+
137+
=== Phase 5: Release & Maintenance
138+
139+
* Initial public release
140+
* Bug fixes and patches
141+
* Feature enhancements
142+
* Community support
143+
144+
== Contributing
145+
146+
Contributions will be welcome once the project specification is in place. See link:CONTRIBUTING.md[CONTRIBUTING.md] for the general process.
147+
148+
== Timeline
149+
150+
_No timeline estimates - specification pending._
151+
152+
== Contact
153+
154+
* Repository: https://github.com/hyperpolymath/snapcreate
155+
* Maintainer: hyperpolymath

0 commit comments

Comments
 (0)