sgx-lkl icon indicating copy to clipboard operation
sgx-lkl copied to clipboard

README cleanup

Open letmaik opened this issue 5 years ago • 0 comments

This meta-issue tracks work related to fixing / simplifying / cleaning up the main project README.

The main idea is to have a short README explaining what SGX-LKL is, plus installation instructions (binary packages), an end-to-end "getting started" sample that's not too complicated, and pointers to other docs for any details or dev-focused topics (like building from source).

  • [ ] Add Getting Started sample with pointers to explore details
  • [ ] Fix incorrect/outdated sections #395
  • [ ] Move non-Docker flows to separate docs #369
  • [ ] Move build-from-source instructions to separate dev doc
  • [ ] Move config section (currently mostly empty) to separate docs
  • [x] Add section on current limitations
  • [ ] Explain app config / host config and sgx-lkl-cfg #351

@jxyang @prp

letmaik avatar Jun 10 '20 09:06 letmaik