docs: document build-from-source install path (unpublished npm package) - #12
Open
weed33834 wants to merge 1 commit into
Open
docs: document build-from-source install path (unpublished npm package)#12weed33834 wants to merge 1 commit into
weed33834 wants to merge 1 commit into
Conversation
The README, docs index, and getting-started guide all instruct users to run `npx @dioptx/cctime` / `npm install -g @dioptx/cctime`, but the package is not published to the npm registry — both commands 404 (dioptx#1). Restructure the Quick Start and Install sections to lead with the build-from-source path (git clone → npm install → npm run build → npm link) that works today, and keep the npx/npm commands under a "From npm (once published)" subsection so they remain ready for when the package ships. Closes dioptx#1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README, docs index, and getting-started guide all instruct users to run
npx @dioptx/cctime/npm install -g @dioptx/cctime, but the package is not published to the npm registry — both commands return 404. This PR documents the build-from-source install path that works today.Changes
git clone→npm install→npm run build→npm link; Install section split into "From source" (primary) and "From npm (once published)" (preserved for when the package ships)The
npx/npm install -gcommands are kept (not removed) under a clearly-labelled "once published" subsection, so they're ready to promote once@dioptx/cctimeis on the registry.Testing
npm testpasses (87 tests, 6 files)npx tsc --noEmitpasses (build succeeds)Related Issues
Closes #1