Update README
This commit is contained in:
parent
c5df3d3f4f
commit
1265491990
36
README.org
36
README.org
@ -4,11 +4,26 @@
|
|||||||
|
|
||||||
* Emacs version
|
* Emacs version
|
||||||
|
|
||||||
This configuration is maintained only for the Emacs master branch version.
|
This configuration is maintained only for the Emacs master branch version. It
|
||||||
It may work on some older version or you may have to remove the features that
|
may work on some older version or you may have to remove the features that
|
||||||
rely on the newer Emacs versions. Currently, this configuration uses a few
|
rely on the newer Emacs versions. Currently, this configuration uses a few
|
||||||
features from Emacs 26 and 27.
|
features from Emacs 26 and 27.
|
||||||
|
|
||||||
|
To fully leverage the features used in this configuration, Emacs must be
|
||||||
|
compiled with the right options.
|
||||||
|
|
||||||
|
** Native JSON
|
||||||
|
|
||||||
|
This configuration uses ~lsp-mode~ for some programming languages which is
|
||||||
|
much faster if Emacs is compiled with native JSON support. Emacs will by
|
||||||
|
default compile with native JSON support if the ~jansson~ library is present
|
||||||
|
(including headers).
|
||||||
|
|
||||||
|
** Dynamic modules
|
||||||
|
|
||||||
|
~vterm~ uses dynamic modules. In order to enable dynamic modules, Emacs must
|
||||||
|
be compiled with the ~--with-modules~ option (not enabled by default).
|
||||||
|
|
||||||
* Installation
|
* Installation
|
||||||
|
|
||||||
Clone this repository into your home directory:
|
Clone this repository into your home directory:
|
||||||
@ -26,6 +41,12 @@
|
|||||||
$ sudo cp ~/.local/source-code-pro/OTF/*.otf /usr/local/share/fonts
|
$ sudo cp ~/.local/source-code-pro/OTF/*.otf /usr/local/share/fonts
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
Once the initial setup completes, you also need to run the following in Emacs
|
||||||
|
|
||||||
|
#+BEGIN_SRC
|
||||||
|
M-x all-the-icons-install-fonts
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
* External Support for Programming Languages
|
* External Support for Programming Languages
|
||||||
|
|
||||||
This configuration relies uses ~lsp-mode~ for language-specific features.
|
This configuration relies uses ~lsp-mode~ for language-specific features.
|
||||||
@ -57,6 +78,9 @@
|
|||||||
$ pip3 install 'python-language-server[all]'
|
$ pip3 install 'python-language-server[all]'
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
Note that when using Python virtual environments it is best to install the
|
||||||
|
language server in the environment itself.
|
||||||
|
|
||||||
** Rust
|
** Rust
|
||||||
|
|
||||||
Install RLS using ~rustup~
|
Install RLS using ~rustup~
|
||||||
@ -67,10 +91,10 @@
|
|||||||
|
|
||||||
* Package Management
|
* Package Management
|
||||||
|
|
||||||
This =.emacs.d= uses its own small framework for package management located
|
This =.emacs.d= uses its own small framework for package management located in
|
||||||
in the [[emodule][emodule]] directory. Its operation is heavily inspired by [[http://spacemacs.org/][Spacemacs]],
|
the [[emodule][emodule]] directory. Its operation is heavily inspired by [[http://spacemacs.org/][Spacemacs]], but is
|
||||||
but is much smaller with fewer features and thus simpler. For instructions,
|
much smaller with fewer features and thus simpler. For instructions, see its
|
||||||
see its own [[emodule/README.org][README file]].
|
own [[emodule/README.org][README file]].
|
||||||
|
|
||||||
* Theme
|
* Theme
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user