Added more information to use this library #92
Conversation
To use this library one had to think around. The new section on the README.md now describes the setup process to use this library. To improve the creation speed even more I created the templates folder. All files within this folder should be copied into a new project.
|
I noticed that after renaming the crate name (#23) you missed to update the README. Also I added a section to describe how to setup the library within a new project (because not everybody wants to add example files into the repository itself ;) ) |
| 1. `deploy.sh` to deploy your code onto your hardware (please check if the correct | ||
| target is selected and the application name matches!) | ||
| 1. `setup.sh` to download and setup the nightly build of Rust, Tockloader and the targets | ||
| 1. `Cargo.toml` for your project (please remember to insert your name as autor and |
| [profile.dev] | ||
| panic = "abort" | ||
| lto = true # Link Time Optimization usually reduces size of binaries and static libraries |
There was a problem hiding this comment.
Would the dev profile be used in practice? It may not even be worth configuring.
| panic = "abort" | ||
| lto = true # Link Time Optimization usually reduces size of binaries and static libraries | ||
|
|
||
| [profile.release] |
There was a problem hiding this comment.
profile.release could also have:
codegen-units = 1 # Enables some additional optimizations
opt-level = "z" # Minimize size (probably more important than performance)
| [package] | ||
| name = "<application>" | ||
| version = "0.1.0" | ||
| authors = ["That's you <[email protected]>"] |
There was a problem hiding this comment.
Do we want to default to edition 2018?
| @@ -0,0 +1,17 @@ | |||
| /* Layout for the Hail board, used by the examples in this repository. */ | |||
There was a problem hiding this comment.
Should the layout files be symlinks to the top-level directory files (or the other way around), to make sure they are kept in sync? Same for rust-toolchain.
|
Two questions:
|
|
Does anyone want to pick this up? I think it needs to be updated, and there have been no responses to review comments. If no-one is interested in working on this then lets close it. |
To use this library one had to think around.
The new section on the README.md now describes
the setup process to use this library.
To improve the creation speed even more I
created the templates folder. All files
within this folder should be copied into a
new project.