Page MenuHomePhabricator

[Chronik] Update README.md
ClosedPublic

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
Branch
chronik-update-readme
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 27665
Build 54893: Build Diffbuild-chronik · chronik-client-integration-tests · build-chronik-plugins
Build 54892: arc lint + arc unit

Event Timeline

The build failed due to an unexpected infrastructure outage. The administrators have been notified to investigate. Sorry for the inconvenience.
Fabien requested changes to this revision.Mar 5 2024, 11:58

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

@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

@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

OK

This revision is now accepted and ready to land.Mar 5 2024, 12:18
This revision was automatically updated to reflect the committed changes.