Differential D15633

[Chronik] Update README.md
ClosedPublic
Actions

Authored by tobias_ruck on Mar 5 2024, 11:34.

Details

Reviewers

Fabien

Group Reviewers

Restricted Project

Commits

rABC82fc71fa49ff: [Chronik] Update README.md

Summary

Currently the README is very outdated and misleading. Add a nice mini-tutorial on how to setup and configure a Chronik instance.

Test Plan

Read the README.md

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

tobias_ruck created this revision.Mar 5 2024, 11:34

Herald added a reviewer: Restricted Project. · View Herald TranscriptMar 5 2024, 11:34

tobias_ruck requested review of this revision.Mar 5 2024, 11:34

Harbormaster completed remote builds in B27665: Diff 45925.Mar 5 2024, 11:43

The build failed due to an unexpected infrastructure outage. The administrators have been notified to investigate. Sorry for the inconvenience.

Can you please add a doc/chronik.md that redirects to this readme ?

This revision now requires changes to proceed.Mar 5 2024, 11:58

rebase

@Fabien Maybe in a separate diff? I also need to update docs/build-*.md on how to build Chronik, or add a docs/build-chronik.md

In D15633#352780, @tobias_ruck wrote:

@Fabien Maybe in a separate diff? I also need to update docs/build-*.md on how to build Chronik, or add a docs/build-chronik.md

This revision is now accepted and ready to land.Mar 5 2024, 12:18

Harbormaster completed remote builds in B27667: Diff 45927.Mar 5 2024, 12:20

Closed by commit rABC82fc71fa49ff: [Chronik] Update README.md (authored by tobias_ruck). · Explain WhyMar 5 2024, 12:33

This revision was automatically updated to reflect the committed changes.

tobias_ruck added a commit: rABC82fc71fa49ff: [Chronik] Update README.md.

Revision Contents
Changeset List

Path

Size

chronik/

README.md

78 lines

Diff 45928

View Options

[Chronik] Update README.mdClosedPublicActions