Skip to content
This repository was archived by the owner on Oct 7, 2020. It is now read-only.

Commit ede8e74

Browse files
authored
Merge pull request #1108 from haskell/readme
Remove some old cruft from README
2 parents 5245042 + 0ac3d16 commit ede8e74

File tree

1 file changed

+7
-33
lines changed

1 file changed

+7
-33
lines changed

README.md

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ we talk to clients.__
3333
- [Docs on hover/completion](#docs-on-hovercompletion)
3434
- [Contributing](#contributing)
3535
- [Planned Features](#planned-features)
36-
- [This is *not* yet another `ghc-mod` or `ide-backend` project](#this-is-not-yet-another-ghc-mod-or-ide-backend-project)
3736
- [It's time to join the project!](#its-time-to-join-the-project)
3837
- [Architecture](#architecture)
3938
- [1. BIOS layer](#1-bios-layer)
@@ -569,10 +568,6 @@ Or you can set the environment variable `HIE_HOOGLE_DATABASE` to specify a speci
569568
- [ ] Cross project/dependency Find Definition
570569
- [ ] Case splitting, type insertion etc.
571570

572-
### This is *not* yet another [`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) or [`ide-backend`](https://github.com/fpco/ide-backend) project
573-
574-
> 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.
575-
576571
This project is not started from scratch:
577572

578573
1. See why [we should supersede previous tools](/docs/Challenges.md)
@@ -589,38 +584,17 @@ This project is not started from scratch:
589584
- Fork this repo and hack as much as you can.
590585
- Ask @alanz or @hvr to join the project.
591586

592-
## Architecture
593-
594-
Below you find a short overview of the main architectural layers of `haskell-ide-engine`.
595-
For more info have a look in [the docs folder](/docs) at the root of this project, especially:
596-
597-
- The [Architecture discussion](docs/Architecture.md)
598-
- The [Protocol discussion](docs/Protocol.md)
599-
- The [Design discussion](docs/Design.md)
600-
601-
### 1. BIOS layer
602-
603-
[`ghc-mod`](https://github.com/kazu-yamamoto/ghc-mod) stays an AGPL project,
604-
and is used for its "awesome sauce" in terms of
605-
the BIOS functions that it does so well. This interface is
606-
[straightforward to use](http://alanz.github.io/haskell%20refactorer/2015/10/02/ghc-mod-for-tooling),
607-
and if a license-constrained user wants to do something else it is also easy to
608-
replace, if there is strong control of the operating environment.
609-
610-
### 2. Plugin layer
611-
612-
A layer providing a point to integrate tools and existing functions, probably
613-
including ghci.
614-
615-
### 3. IDE interfacing layer
587+
## Documentation
616588

617-
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.
589+
All the documentation is in [the docs folder](/docs) at the root of this project.
618590

619-
Existing transports are still functional for the time being.
591+
### Architecture
620592

621-
## Documentation
593+
Have a look at
622594

623-
All the documentation is in [the docs folder](/docs) at the root of this project.
595+
- the [Architecture discussion](docs/Architecture.md),
596+
- [Protocol discussion](docs/Protocol.md) and
597+
- [Design discussion](docs/Design.md).
624598

625599
## Troubleshooting
626600

0 commit comments

Comments
 (0)