Skip to content

Commit

Permalink
README: Add a few source code starting points (#4421)
Browse files Browse the repository at this point in the history
Co-authored-by: John Freeman <jfreeman08@gmail.com>
  • Loading branch information
intelliot and thejohnfreeman authored Feb 18, 2023
1 parent aebf2ac commit 96aab12
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,12 @@ The server software that powers the XRP Ledger is called `rippled` and is availa


## Source Code
[![travis-ci.com: Build Status](https://travis-ci.com/ripple/rippled.svg?branch=develop)](https://travis-ci.com/ripple/rippled)
[![codecov.io: Code Coverage](https://codecov.io/gh/ripple/rippled/branch/develop/graph/badge.svg)](https://codecov.io/gh/ripple/rippled)

Here are some good places to start learning the source code:

- Read the markdown files in the source tree: `src/ripple/**/*.md`.
- Read [the levelization document](./Builds/levelization) to get an idea of the internal dependency graph.
- In the big picture, the `main` function constructs an `ApplicationImp` object, which implements the `Application` virtual interface. Almost every component in the application takes an `Application&` parameter in its constructor, typically named `app` and stored as a member variable `app_`. This allows most components to depend on any other component.

### Repository Contents

Expand Down

0 comments on commit 96aab12

Please sign in to comment.