Improve README with clearer description and getting started guide#68
Merged
Conversation
The Codama-generated client under tools/shank-and-codama emits `{}` arg
types that trip biome's noBannedTypes rule. Generated code is not
hand-maintained and is overwritten on regeneration, so exclude any
generated/ directory from linting.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the README to provide clearer positioning of the repository, add a "Getting started" section with setup instructions, and enhance the "Financial Software" section with better context about the programs included.
Key Changes
pnpm test)Notable Details
These changes improve the onboarding experience for new developers by providing clear prerequisites, setup steps, and context about what financial primitives are being taught through the examples.
https://claude.ai/code/session_012LzSMSq6U49UoXUEPgWkjV