29 lines
1.3 KiB
Org Mode
29 lines
1.3 KiB
Org Mode
|
* Project Vision
|
|||
|
|
This repository provides a fully isolated, reproducible, and portable Emacs configuration, intended to be independent from any other desktop or dotfile management setup.
|
|||
|
|
|
|||
|
|
* Project Architecture
|
|||
|
|
- Overlay on top of [Crafted Emacs](https://github.com/SystemCrafters/crafted-emacs).
|
|||
|
|
- All configuration lives in this repo; the user overlays, custom modules, and extensions are layered atop the base Crafted Emacs clone.
|
|||
|
|
- Expected installation: Clone this repository into ~/.config/emacs, after Crafted Emacs is already installed (as per Crafted’s instructions).
|
|||
|
|
|
|||
|
|
* Constraints
|
|||
|
|
- This repository must not require modification of general dotfiles or system-wide config.
|
|||
|
|
- Should be instantly usable on new systems with minimal post-clone setup.
|
|||
|
|
- Must avoid platform-specific logic wherever possible.
|
|||
|
|
|
|||
|
|
* Tooling & Stack
|
|||
|
|
- Written in Emacs Lisp.
|
|||
|
|
- Managed/documented in Org Mode (literate config is assumed or encouraged).
|
|||
|
|
- Future: Optional make/auto-tangle system for build automation if needed.
|
|||
|
|
|
|||
|
|
* Contribution Workflow
|
|||
|
|
1. Fork this repo, work on feature branches.
|
|||
|
|
2. PRs are reviewed for quality and clarity.
|
|||
|
|
3. New features/fixes should be documented in README.org and tracked in TASK.org.
|
|||
|
|
|
|||
|
|
* Open Questions
|
|||
|
|
- Should we enforce any init.el tangling conventions or pre-commit hooks for Org files?
|
|||
|
|
|
|||
|
|
* Next Steps
|
|||
|
|
- See TASK.org for actionable next moves.
|