diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 424f2ad..4ae258f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,15 @@ Thank you for your interest in contributing to TORCH! - Node.js (v22+) - npm +## User Onboarding Reference + +Use this exact happy-path command sequence when onboarding TORCH into another repository: + +```bash +npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz \ + && npx --no-install torch-lock init +``` + ## Setup 1. Clone the repository. diff --git a/README.md b/README.md index c3a2112..7235547 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,21 @@ TORCH isn't just another script—it's an operating system for your AI workforce ## Installation +Prerequisites: + +- Node.js 22 or newer + +First 5 minutes: + ```bash -npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz +npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz \ + && npx --no-install torch-lock init + +# sanity check (optional, but recommended) +npx --no-install torch-lock check --cadence daily + +# start dashboard +npx --no-install torch-lock dashboard --port 4173 --host 127.0.0.1 ``` > TORCH is distributed from GitHub tarballs and is not currently published to the npm registry. diff --git a/landing/index.html b/landing/index.html index 74d61a0..17def05 100644 --- a/landing/index.html +++ b/landing/index.html @@ -233,15 +233,18 @@ .prompt-content pre { margin: 0; padding: 1.5rem; + overflow: auto; } .prompt-content code { + display: block; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace; font-size: 0.85rem; color: #e6edf3; line-height: 1.5; - white-space: pre-wrap; - word-break: break-all; + white-space: pre; + word-break: normal; + overflow-wrap: normal; } footer { @@ -783,16 +786,18 @@ #promptModal .modal-body pre { margin: 0; padding: 1.5rem; + overflow: auto; } #promptModal .modal-body code { + display: block; font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace; font-size: 0.9rem; color: #e6edf3; line-height: 1.5; - white-space: pre-wrap; - word-break: break-all; - overflow-wrap: break-word; + white-space: pre; + word-break: normal; + overflow-wrap: normal; } #promptModal .close-prompt { @@ -932,11 +937,12 @@ -

Copy this prompt to onboard TORCH:

+

Copy this happy-path prompt to onboard TORCH:

+

Requires Node.js 22+.

Hey Jules, can you install and setup TORCH into this repo? Here is the install command: -npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz && npx torch-lock init +npm install https://github.com/PR0M3TH3AN/TORCH/archive/refs/heads/main.tar.gz && npx --no-install torch-lock init