Skip to content

Commit

Permalink
docs: Add comment on how to better structure Swim projects (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanuppal authored Feb 4, 2025
1 parent 0865663 commit 3bad9df
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/testing_spade.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,22 @@ fn main() -> Result<(), Whatever> {
```

A `cargo run` from the project root lets us test our Spade!

## A note on project structure

While I tried to make this tutorial as easy to follow as possible, I don't
necessarily believe the file structure presented above is optimal. I recommend
having a `Cargo.toml` at project root and various `[[bin]]`s for each test in a
`test/` folder, also at project root.

```
.
β”œβ”€β”€ Cargo.lock
β”œβ”€β”€ Cargo.toml
β”œβ”€β”€ swim.lock
β”œβ”€β”€ swim.toml
β”œβ”€β”€ src
β”‚ └── fft.spade
└── test
└── unit.rs
```

0 comments on commit 3bad9df

Please sign in to comment.