Add project README with setup and usage instructions #7
Conversation
Introduces a README.md detailing repository structure, prerequisites, installation steps, usage examples, testing instructions, and licensing for the bdk-dart project.
|
Thanks, I attached the Issue #6 that this would close, and I'll review this this week! |
| The repo packages the generated UniFFI bindings (`lib/bdk.dart`) together with the | ||
| compiled `libbdkffi` native library so Dart and Flutter apps can work with descriptor-based |
There was a problem hiding this comment.
these are gitignored though I thought? or maybe we just need to reword?
There was a problem hiding this comment.
Ah yes, you’re right, the generated bindings and native libs are gitignored.
I can reword this section to clarify that the repo provides the sources + UniFFI config, and that the generated artifacts are produced locally rather than checked in
| | Path | Purpose | | ||
| | ---- | ------- | | ||
| | `bdk-ffi/` | Rust sources and build scripts for the underlying `bdk-ffi` crate. | | ||
| | `lib/` | Generated Dart bindings (`bdk.dart`) produced by UniFFI-Dart. | |
There was a problem hiding this comment.
implies lib/ contains checked-in bindings which I'm not sure is the case
| | `bdk-ffi/` | Rust sources and build scripts for the underlying `bdk-ffi` crate. | | ||
| | `lib/` | Generated Dart bindings (`bdk.dart`) produced by UniFFI-Dart. | | ||
| | `examples/` | Standalone Dart examples that exercise common workflows. | | ||
| | `test/` | Integration-style tests that cover wallet creation, persistence, and networking. | |
There was a problem hiding this comment.
maybe we change this to something like Dart unit tests for wallet construction, offline behavior, persistence or something since we only have offline tests at the moment?
| ```bash | ||
| dart pub get | ||
| ``` | ||
| 2. Generate the Dart bindings and native binary: |
There was a problem hiding this comment.
should we add something like (macOS or Linux host required) here?
There was a problem hiding this comment.
Yes, it’s a good idea since it directly addresses the reviewer’s question about the host requirements for generating bindings
|
@Johnosezele are you interested in reviewing this? |
Added LICENSE, LICENSE-APACHE, and LICENSE-MIT files to clarify project licensing under Apache 2.0 or MIT, at the user's option.
2 participants
token #6
Introduces a README.md detailing repository structure, prerequisites, installation steps, usage examples, testing instructions, and licensing for the bdk-dart project.