Skip to content

docs: Update README to use Makefile targets - #193

Merged
joncinque merged 1 commit into
solana-program:mainfrom
imitater-dou:docs/readme-makefile-targets
Oct 27, 2026
Merged

joncinque merged 1 commit into
solana-program:mainfrom
imitater-dou:docs/readme-makefile-targets

Conversation

@imitater-dou

Copy link
Copy Markdown
Contributor

Summary

The root README.md is still the original create-solana-program template text. All of the pnpm scripts it documents (programs:build, programs:test, programs:format, programs:lint, generate:clients, generate, validator:start, validator:restart, validator:stop) no longer exist: the root package.json has no scripts section, and the repo now uses the Makefile (the same commands CI runs through solana-program/actions, and the ones clients/js/README.md already uses).

The validator sections no longer apply either. There are no validator scripts in scripts/, the program tests run on Mollusk, and the JS client tests load target/deploy/pinocchio_token_program.so into LiteSVM. program-dependencies also isn't used anywhere in the repo.

Changes

  • Replace the template intro with a short overview of program, pinocchio/program, the two interface crates, and clients/js.
  • Document the Makefile equivalents: make build-sbf-{program,pinocchio-program}, make test-{program,pinocchio-program}, make format-check-program, make clippy-program, make generate-clients, and make test-js-clients-js, plus how package names map to directories (pinocchio-program → pinocchio/program).
  • Remove the local validator and program-dependencies sections.

Docs only. No code changes.

How to verify

jq .scripts package.json                    # null: none of the documented pnpm scripts exist
ls scripts/                                 # no validator scripts
make -n build-sbf-pinocchio-program         # cargo build-sbf --manifest-path pinocchio/program/Cargo.toml
make -n test-program                        # SBF_OUT_DIR=.../target/deploy cargo +nightly-... test --manifest-path program/Cargo.toml
make -n test-js-clients-js                  # cd clients/js && pnpm install && pnpm build && pnpm test
make -n generate-clients                    # pnpm codama run --all
grep -n 'Mollusk::new\|add_program' program/tests/processor.rs pinocchio/program/tests/setup/mollusk.rs

The root README still described the create-solana-program template:
the pnpm scripts it lists (programs:*, generate*, validator:*) no
longer exist since the root package.json has no scripts, and there are
no local validator scripts. Document the Makefile targets used by CI
instead, and drop the validator sections since tests run on Mollusk
and LiteSVM.

Signed-off-by: ADou <ikun3.1415927@gmail.com>

@joncinque joncinque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution

@joncinque
joncinque merged commit 737788f into solana-program:main Oct 27, 2026
29 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants