aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-08-19 13:15:12 +0200
committerGitHub <noreply@github.com>2017-08-19 13:15:12 +0200
commitb3da396804ec0a63f11b86a363bd4c98e23f8ebd (patch)
treecf437e397f9e06594de73f4ac65f9725c303449f /README.md
parentf465bf0cfa3c20152de2d3ca2ddede9fbcde086e (diff)
parentb13070ec01844977f10cae38fc6f2a0fd9defad8 (diff)
downloadrneovim-b3da396804ec0a63f11b86a363bd4c98e23f8ebd.tar.gz
rneovim-b3da396804ec0a63f11b86a363bd4c98e23f8ebd.tar.bz2
rneovim-b3da396804ec0a63f11b86a363bd4c98e23f8ebd.zip
Merge #7171 from justinmk/doc
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 18 insertions, 11 deletions
diff --git a/README.md b/README.md
index 0442ee61de..4016c9b3c2 100644
--- a/README.md
+++ b/README.md
@@ -48,17 +48,24 @@ and [more](https://github.com/neovim/neovim/wiki/Installing-Neovim)!
Project layout
--------------
- ├─ ci/ Build server scripts
- ├─ cmake/ Build scripts
- ├─ runtime/ User plugins/docs
- ├─ src/ Source code
- ├─ third-party/ CMake subproject to build dependencies
- └─ test/ Test code
-
-- `third-party/` is activated if `USE_BUNDLED_DEPS` is undefined or the
- `USE_BUNDLED` CMake option is true.
-- [Source README](src/nvim/README.md)
-- [Test README](test/README.md)
+ ├─ ci/ build automation
+ ├─ cmake/ build scripts
+ ├─ runtime/ user plugins/docs
+ ├─ src/ application source code (see src/nvim/README.md)
+ │ ├─ api/ API subsystem
+ │ ├─ eval/ VimL subsystem
+ │ ├─ event/ event-loop subsystem
+ │ ├─ generators/ code generation (pre-compilation)
+ │ ├─ lib/ generic data structures
+ │ ├─ lua/ lua subsystem
+ │ ├─ msgpack_rpc/ RPC subsystem
+ │ ├─ os/ low-level platform code
+ │ └─ tui/ built-in UI
+ ├─ third-party/ cmake subproject to build dependencies
+ └─ test/ tests (see test/README.md)
+
+- To disable `third-party/` specify `USE_BUNDLED_DEPS=NO` or `USE_BUNDLED=NO`
+ (CMake option).
Features
--------