Skip to content

Commit

Permalink
Add more doc about the heed3 script
Browse files Browse the repository at this point in the history
  • Loading branch information
Kerollmops committed Dec 3, 2024
1 parent 73e8e31 commit 446d2bd
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
}
```

## Working with two Crates: heed and heed3

The heed and heed3 crates manage a shared codebase. Within the heed3 folder, you can find the Cargo.toml specific to the heed3 crate.
To facilitate work on heed3, utilize the `convert-to-heed3.sh` script.

This script conveniently moves the `heed3/Cargo.toml` file to the `heed/` folder, updates the `heed::` references to `heed3::`, and generates a commit for easy rollback if needed.

## Building from Source

You can use this command to clone the repository:
Expand Down

0 comments on commit 446d2bd

Please sign in to comment.