diff --git a/README.md b/README.md index 32e606b..61c6bb6 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ This project is heavily inspired by Microsoft Live Share plugin for Visual Studi While the functionality is incredibly good, I often find issues or glitches which slow me down, and being locked to only use Visual Studio products is limiting. I decided to write my own solution, and to make it open source, so that any editor can integrate it with a plugin. +### Documentation +build the crate documentation with `cargo doc` and access the codemp page with the html redirect `docs.html` + # Design ## Client/Server While initially a P2P system seemed interesting, I don't think it would easily scale with many users (due to having to integrate many changes on each client). @@ -17,14 +20,3 @@ Each editor plugin must be responsible of mapping codemp functionality to actual A non destructive way to sync changes across clients is necessary. I initially explored CRDTs, but implementation seemed complex with little extra benefits from "more traditional" approaches (Operational Transforms). This has to be investigated more. - -# Roadmap -* [x] Initial design choices -* [x] Simple GRPC server with tonic -* [x] Simple neovim client with RPC/msgpack -* [ ] Implementing core protocol routes -* [ ] Simple neovim client capable of displaying other person cursor -* [ ] Implement OTs / CRTDs for sharing file deltas -* [ ] More clients (VSCode? JetBrains IDEs?) -* [ ] LSP functionality bridged to guests from host? -* [ ] Full remote development suite by keeping the project repo on a server?