From 1df1a06d5bac86ab977aeff33b0bb03d2e0b753d Mon Sep 17 00:00:00 2001 From: smile13241324 Date: Wed, 29 Nov 2017 20:47:06 +0100 Subject: [PATCH] Fix documentation for java, major-modes and purescript layer --- layers/+lang/java/README.org | 19 +++++++++++------ layers/+lang/major-modes/README.org | 32 +++++++++++++++-------------- layers/+lang/purescript/README.org | 16 +++++++++------ 3 files changed, 40 insertions(+), 27 deletions(-) diff --git a/layers/+lang/java/README.org b/layers/+lang/java/README.org index 6238c8803..384b58dff 100644 --- a/layers/+lang/java/README.org +++ b/layers/+lang/java/README.org @@ -4,6 +4,7 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] + - [[#features][Features:]] - [[#layer-installation][Layer Installation]] - [[#layer][Layer]] - [[#choosing-a-backend][Choosing a backend]] @@ -59,10 +60,17 @@ - [[#repl][REPL]] * Description -This layer adds support for the Java language, it supports multiple backends: -- the [[https://github.com/mopemope/meghanada-emacs][Meghanada]] client/server (default), -- the [[http://eclim.org][Eclim]] client/server, -- the [[https://ensime.github.io/][ENSIME]] client/server. +This layer adds support for the Java language. + +** Features: +- Support for the following backends: + - [[https://github.com/mopemope/meghanada-emacs][Meghanada]] client/server (default), + - [[http://eclim.org][Eclim]] client/server, + - [[https://ensime.github.io/][ENSIME]] client/server. +- Each provides: + - Auto-completion using company + - Linting using flycheck integration + - Maven and Gradle integration * Layer Installation ** Layer @@ -125,8 +133,7 @@ at the root of your project first. ** Eclim Eclim provides the ability to access Eclipse features such as code completion, -searching, code validation, and many more. This is the default value for the -layer variable =java-backend=. +searching, code validation, and many more. *** Installation **** Eclipse diff --git a/layers/+lang/major-modes/README.org b/layers/+lang/major-modes/README.org index b6fa00c08..01ac7127c 100644 --- a/layers/+lang/major-modes/README.org +++ b/layers/+lang/major-modes/README.org @@ -2,6 +2,7 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] + - [[#features][Features:]] - [[#key-bindings][Key bindings]] - [[#arch-linux-pkgbuilds][Arch Linux PKGBUILDs]] - [[#gentoo-ebuilds][Gentoo ebuilds]] @@ -9,21 +10,22 @@ * Description This layer adds a number of packages for less common languages and major modes. -These include: -- Arch Linux PKGBUILDs -- Arduino -- Android Logcat (not associated with any file types by default) -- Gentoo ebuilds -- Hoon -- Julia -- Kivy -- MATLAB -- QML -- OpenScad -- Stan -- Thrift -- Vala -- Wolfram Language / Mathematica +** Features: +- Support for: + - Arch Linux PKGBUILDs + - Arduino + - Android Logcat (not associated with any file types by default) + - Gentoo ebuilds + - Hoon + - Julia + - Kivy + - MATLAB + - QML + - OpenScad + - Stan + - Thrift + - Vala + - Wolfram Language / Mathematica * Key bindings ** Arch Linux PKGBUILDs diff --git a/layers/+lang/purescript/README.org b/layers/+lang/purescript/README.org index 0e1d61804..daa915fe6 100644 --- a/layers/+lang/purescript/README.org +++ b/layers/+lang/purescript/README.org @@ -4,6 +4,7 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] + - [[#features][Features:]] - [[#install][Install]] - [[#configuration][Configuration]] - [[#add-import-on-completion][Add import on completion]] @@ -15,11 +16,14 @@ - [[#repl][REPL]] * Description -This layer provides basic Purescript editing support for spacemacs -thanks to the following packages: -- [[https://github.com/dysinger/purescript-mode][purescript-mode]] -- [[https://github.com/ardumont/emacs-psci][psci]] -- [[https://github.com/epost/psc-ide-emacs][psc-ide-emacs]] +This layer provides basic Purescript editing support for spacemacs. + +** Features: +- Syntax highlighting through [[https://github.com/dysinger/purescript-mode][purescript-mode]] +- Automatic insert of imports through [[https://github.com/epost/psc-ide-emacs][psc-ide-emacs]] +- REPL through [[https://github.com/ardumont/emacs-psci][psci]] +- Syntax checking through flycheck +- Autocompletion through company * Install To use this configuration layer, add it to your =~/.spacemacs=. You will need to @@ -33,7 +37,7 @@ can be found [[https://github.com/purescript/documentation/blob/master/guides/Ge * Configuration ** Add import on completion Set =purescript-add-import-on-completion= to nil to make =psc-ide= stop adding -imports on completion. Default value it =t=. +imports on completion. Default value is =t=. ** Error popup If you set =purescript-enable-rebuild-on-save= to non-nil, you will get a popup