Docs: README updates #607
Docs: README updates #607
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #607 +/- ##
=======================================
Coverage 73.11% 73.11%
=======================================
Files 63 63
Lines 4077 4077
=======================================
Hits 2981 2981
Misses 1096 1096
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…ence to canopy. Also use fre make and not fremake
…re make all and revise quickstart to be less duplicative.
| # Create and run the compile script | ||
| fre make compile-script -y [model yaml file] -p [platform] -t [target] --execute | ||
|
|
||
| # Run all of fremake | ||
| # Run fre make checkout-script, fre make makefile, and fre make compile-script in order |
There was a problem hiding this comment.
Would you be able to put this in it's own code blurb? Like have a snippet of explanation like "Or run the fre make steps in an all-encompassing tool ..." right before, then add the fre make all command.
I don't want it to seem like the user has to run all the steps AND the all step
| # Create and run checkout script | ||
| fre make checkout-script -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute | ||
|
|
||
| # Create Makefile | ||
| fre make makefile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] | ||
|
|
||
| #Create a Dockerfile | ||
| fre make dockerfile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] | ||
|
|
||
| # Create and run the Dockerfile | ||
| fre make dockerfile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute | ||
| ``` |
There was a problem hiding this comment.
Following my other comment - the same things but with container platform:
fre make all -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute will create a container
Describe your changes
Issue ticket number and link (if applicable)
Fixes #455
Fixes #547
Checklist before requesting a review