tsffs icon indicating copy to clipboard operation
tsffs copied to clipboard

Suggestions to improve the documentation

Open kerneis-anssi opened this issue 1 year ago • 1 comments

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.

kerneis-anssi avatar Mar 13 '24 10:03 kerneis-anssi

Thanks for the notes, I'll incorporate these suggestions in the next docs update.

novafacing avatar Mar 13 '24 17:03 novafacing