Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write documentations #29

Open
9 tasks
kory33 opened this issue Nov 26, 2021 · 0 comments
Open
9 tasks

Write documentations #29

kory33 opened this issue Nov 26, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kory33
Copy link
Owner

kory33 commented Nov 26, 2021

There is a lot of things to write!

On usage

  • how to setup a testing project in SBT
  • how to include s2mc-test as a dependency
  • how to write a test suite, including how to define packet abstractions and so on
  • (for a reference, a complete example project (in a separate repository) is desirable)

On the library itself

  • the core principle that this library follows (namely, multi-version compatibility, conservative type safety and scalable testing facility)
  • how modules are structured
  • how protocol versions are managed
  • explanation on SightedClients:
    • world views and monocle.Lens
    • packet abstraction (optionally, how we are forcing compiler to resolve correct packet abstraction for a protocol)
@kory33 kory33 added the documentation Improvements or additions to documentation label Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant