diff --git a/README.md b/README.md index 760868d46..1cbcec29c 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,6 @@ we talk to clients.__ - [Docs on hover/completion](#docs-on-hovercompletion) - [Contributing](#contributing) - [Planned Features](#planned-features) - - [This is *not* yet another `ghc-mod` or `ide-backend` project](#this-is-not-yet-another-ghc-mod-or-ide-backend-project) - [It's time to join the project!](#its-time-to-join-the-project) - [Architecture](#architecture) - [1. BIOS layer](#1-bios-layer) @@ -569,10 +568,6 @@ Or you can set the environment variable `HIE_HOOGLE_DATABASE` to specify a speci - [ ] Cross project/dependency Find Definition - [ ] Case splitting, type insertion etc. -### This is *not* yet another [`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) or [`ide-backend`](https://github.com/fpco/ide-backend) project - - > Both the ghc-mod and ide-backend maintainers have agreed to contribute code to this new repository and then rebase the old repos on this. The reason we're using a new repo instead of modifying one of the existing ones is so that the existing projects experience no disruption during this migration process. If this was a new set of people starting a new project without support from existing projects, I'd agree with you. But Alan's reached out to existing players already, which is an important distinction. - This project is not started from scratch: 1. See why [we should supersede previous tools](/docs/Challenges.md) @@ -589,38 +584,17 @@ This project is not started from scratch: - Fork this repo and hack as much as you can. - Ask @alanz or @hvr to join the project. -## Architecture - -Below you find a short overview of the main architectural layers of `haskell-ide-engine`. -For more info have a look in [the docs folder](/docs) at the root of this project, especially: - - - The [Architecture discussion](docs/Architecture.md) - - The [Protocol discussion](docs/Protocol.md) - - The [Design discussion](docs/Design.md) - -### 1. BIOS layer - -[`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) stays an AGPL project, -and is used for its "awesome sauce" in terms of -the BIOS functions that it does so well. This interface is -[straightforward to use](http://alanz.github.io/haskell%20refactorer/2015/10/02/ghc-mod-for-tooling), -and if a license-constrained user wants to do something else it is also easy to -replace, if there is strong control of the operating environment. - -### 2. Plugin layer - -A layer providing a point to integrate tools and existing functions, probably -including ghci. - -### 3. IDE interfacing layer +## Documentation -The focus is currently on [LSP](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md) as the protocol we use to interface with IDEs. +All the documentation is in [the docs folder](/docs) at the root of this project. -Existing transports are still functional for the time being. +### Architecture -## Documentation +Have a look at -All the documentation is in [the docs folder](/docs) at the root of this project. + - the [Architecture discussion](docs/Architecture.md), + - [Protocol discussion](docs/Protocol.md) and + - [Design discussion](docs/Design.md). ## Troubleshooting