intel / intel/tsffs

Suggestions to improve the documentation

Open
#65 1 comment 0 reactions 1 assignee Claimed by @novafacing View on GitHub
Dominant language
Rust
Stars
331
Forks
26
Avg merge
1d 5h
Merged PRs (30d)
2

Description

Thanks a lot for this tool and its detailed documentation which make it easy to get started.

A few things I noticed while following the provided instructions:

- you should add `libXpm` and `gtk2` to the list of dependencies on https://intel.github.io/tsffs/setup/linux.html#install-local-dependencies
- https://intel.github.io/tsffs/fuzzing/compatibility.html uses `test.efi` to test micro-checkpoints, but the sample output ("Working...") corresponds to `HelloWorld.efi` from the tutorial section. It is a good thing to prefer test.efi here (since it doesn't require docker to compile), you should just update the text to mention the expected output is "4141414141414141" rather than "Working..."
- in the same section, you should use `./build.sh` rather than `ninja` to build, otherwise the tsffs header is missing and linking fails.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.