From 405345fb6a33270b1604b22cc500e7afd138d07e Mon Sep 17 00:00:00 2001 From: Thomas Walker Lynch Date: Sun, 8 Mar 2026 14:58:26 +0000 Subject: [PATCH] adds README.md --- README.md | 1 + document/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 120000 README.md create mode 100644 document/README.md diff --git a/README.md b/README.md new file mode 120000 index 0000000..d1aeb59 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +document/README.md \ No newline at end of file diff --git a/document/README.md b/document/README.md new file mode 100644 index 0000000..dc02733 --- /dev/null +++ b/document/README.md @@ -0,0 +1,28 @@ +# Harmony + +Harmony provides a language-agnostic project directory structure and maintenance tools for long-lived software development. It enforces clarity about where things live, utilizing role-based work areas and the strict separation of skeleton, team member authored, machine-made, and third-party software. + +While designed to manage the complexity of multi-person teams, Harmony serves equally well for an individual developer. A single person can easily assume the roles of administrator, developer, and tester simultaneously by opening separate emacs buffers or terminal windows for each role. + +## Bootstrapping a New Project + +**Important:** Do not begin writing code directly in a fresh clone of this skeleton. You must decouple your new project from the Harmony version control history to prevent accidentally committing your project files back to the upstream skeleton. + +To create a Harmony-based project, the project administrator performs these steps: + +1. Clone the Harmony project to a local directory. +2. Remove the `.git` tree. +3. Rename the Harmony directory to the name of the new project. +4. Rename the `0pus_Harmony` file to reflect the name of the new project. +5. Add a line to the `shared/tool/version` file for the new project. +6. Run `git init -b core_developer_branch` to start your own repository. + +## Viewing the Documentation + +To view the project documentation with its intended formatting, a person must provide the RT style library. It is recommended to clone the styling repository side-by-side with your new project directory, and then link it into the third-party directory. + +From the root of your new project repository, run: + +```bash +cd shared/third_party +ln -s ../../../RT-style-JS_public RT-style-JS_public -- 2.20.1