Page MenuHomePhabricator
Differential D18459

[Cashtab] Improve documentation
ClosedPublic
Actions

Authored by bytesofman on Aug 7 2025, 22:34.

Details

Reviewers
PiRK
Group Reviewers
Restricted Project
Commits
rABC0b98e7589186: [Cashtab] Improve documentation
Summary

A few related improvements to make Cashtab more accessible for devs.

  1. We script the complicated prep and installation of local dependencies
  2. We update the README to reference the script (and remove obsolete stuff)
  3. We add a .env.example file to show what env vars are used by Cashtab.
Test Plan

proofread, follow quickstart instructions in readme

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

bytesofman created this revision.Aug 7 2025, 22:34
Herald added a reviewer: Restricted Project. · View Herald TranscriptAug 7 2025, 22:34
Harbormaster completed remote builds in B34073: Diff 55134.Aug 7 2025, 22:34
bytesofman updated this revision to Diff 55135.Aug 7 2025, 22:38

lint

Harbormaster completed remote builds in B34074: Diff 55135.Aug 7 2025, 22:43
bytesofman published this revision for review.Aug 7 2025, 22:55
bytesofman retitled this revision from [Cashtab] Improve README and script dep prep to [Cashtab] Improve documentation.
bytesofman edited the summary of this revision. (Show Details)
PiRK accepted this revision.Aug 8 2025, 08:46
PiRK added a subscriber: PiRK.

Ideally you would want that install-deps.sh script to be run in some CI job so we get an error when dependencies change and we forget to update it.
But this diff is already an improvement vs just listing the dependencies in a doc file/

This revision is now accepted and ready to land.Aug 8 2025, 08:46
Closed by commit rABC0b98e7589186: [Cashtab] Improve documentation (authored by bytesofman). · Explain WhyAug 8 2025, 22:10
This revision was automatically updated to reflect the committed changes.
bytesofman added a commit: rABC0b98e7589186: [Cashtab] Improve documentation.

Revision Contents
Changeset List

PathSize
cashtab/
116 lines
14 lines
68 lines
4 lines
2 lines

Diff 55143

View Options

cashtab/README.md

Loading...
View Options

cashtab/env.example

Loading...
View Options

cashtab/install-deps.sh

Loading...
View Options

cashtab/package-lock.json

Loading...
View Options

cashtab/package.json

Loading...