add README.md generation in the sketch-dist folder
#17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The generated README.md contains commands that helps on how to replicate the build environment
cmd/compile.go
Outdated
Comment on lines
380
to
382
| for _, readmeLib := range returnJson.LibsInfo { | ||
| readmeContent = append(readmeContent, "`arduino-cli lib install "+readmeLib.Name+"@"+readmeLib.Version+"`") | ||
| } |
There was a problem hiding this comment.
Suggested change
| for _, readmeLib := range returnJson.LibsInfo { | |
| readmeContent = append(readmeContent, "`arduino-cli lib install "+readmeLib.Name+"@"+readmeLib.Version+"`") | |
| } | |
| libs := []string{} | |
| for _, l := range returnJson.LibsInfo { | |
| libs = append(libs, l.Name+"@"+l.Version) | |
| } | |
| readmeContent = append(readmeContent, fmt.Sprintf("`arduino-cli lib install %s`", strings.Join(libs, " "))) |
If this change is applied you'll also need to update the example in README.md.
cmd/compile.go
Outdated
Comment on lines
377
to
399
| // generate the commands to run to successfully reproduce the build environment, they will be used as content for the README.md | ||
| var readmeContent []string | ||
| readmeContent = append(readmeContent, "`arduino-cli core install "+returnJson.CoreInfo.Id+"@"+returnJson.CoreInfo.Version+"`") | ||
| for _, readmeLib := range returnJson.LibsInfo { | ||
| readmeContent = append(readmeContent, "`arduino-cli lib install "+readmeLib.Name+"@"+readmeLib.Version+"`") | ||
| } | ||
| // make the paths relative, absolute paths are too long and are different on the user machine | ||
| sketchFileRelPath, _ := sketchFilePath.RelFrom(workingDir) | ||
| libRelDir, _ := libDir.RelFrom(workingDir) | ||
| readmeCompile := "`arduino-cli compile -b " + fqbn + " " + sketchFileRelPath.String() + " --library " + libRelDir.String() + "`" | ||
|
|
||
| //create the README.md file containig instructions regarding what commands to run in order to have again a working binary | ||
| // the README.md contains the following: | ||
| readmeMd := `This package contains firmware code loaded in your product. | ||
| The firmware contains additional code licensed with LGPL clause; in order to re-compile the entire firmware bundle, please execute the following. | ||
|
|
||
| ## Install core and libraries | ||
| ` + strings.Join(readmeContent, "\n") + "\n" + ` | ||
| ## Compile | ||
| ` + readmeCompile + "\n" | ||
|
|
||
| readmeMdPath := rootDir.Join("README.md") | ||
| createFile(readmeMdPath, readmeMd) |
There was a problem hiding this comment.
I'd move this logic into a separate function. The createLib function is quite big already, separating parts of in different function will make it easier to understand.
umbynos
force-pushed
the
umbynos/readme_generation
branch
from
aa54c38 to
1ace2cf
Compare
silvanocerza
suggested changes
Jan 31, 2022
…s for better readability
umbynos
force-pushed
the
umbynos/readme_generation
branch
from
1ace2cf to
7b9831a
Compare
silvanocerza
approved these changes
Jan 31, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The generated
README.mdcontains commands that help on how to replicate the build environment