README.md
changeset 113 79c72453f70d
parent 112 c4c346aa93ab
equal deleted inserted replaced
112:c4c346aa93ab 113:79c72453f70d
    30 - **marginalia** - Helpful annotations in completion candidates
    30 - **marginalia** - Helpful annotations in completion candidates
    31 
    31 
    32 ### Development
    32 ### Development
    33 - **company** - Auto-completion
    33 - **company** - Auto-completion
    34 - **flycheck** - Syntax checking
    34 - **flycheck** - Syntax checking
       
    35 - **jinx** - Fast spell-checking (requires enchant)
    35 - **treesit-auto** - Tree-sitter modes with automatic grammar installation
    36 - **treesit-auto** - Tree-sitter modes with automatic grammar installation
    36 - **magit** - Git interface
    37 - **magit** - Git interface
    37 - **forge** - GitHub/GitLab integration for magit
    38 - **forge** - GitHub/GitLab integration for magit
    38 - **magit-todos** - Show TODO/FIXME comments in magit status
    39 - **magit-todos** - Show TODO/FIXME comments in magit status
    39 
    40 
    79 - `M-y` - Yank from kill ring (enhanced with consult)
    80 - `M-y` - Yank from kill ring (enhanced with consult)
    80 - `M-/` - Company completion
    81 - `M-/` - Company completion
    81 
    82 
    82 ## Installation
    83 ## Installation
    83 
    84 
       
    85 ### Prerequisites
       
    86 
       
    87 **macOS:**
       
    88 ```bash
       
    89 brew install enchant pkg-config
       
    90 ```
       
    91 
       
    92 **Ubuntu/Debian:**
       
    93 ```bash
       
    94 sudo apt install libenchant-2-dev pkg-config
       
    95 ```
       
    96 
       
    97 ### Setup
       
    98 
    84 1. Clone this repository:
    99 1. Clone this repository:
    85    ```bash
   100    ```bash
    86    git clone [email protected]:lukehoersten/emacs.d.git ~/.emacs.d
   101    git clone [email protected]:lukehoersten/emacs.d.git ~/.emacs.d
    87    ```
   102    ```
    88 
   103 
    89 2. Launch Emacs - packages will auto-install on first run
   104 2. Launch Emacs - packages will auto-install on first run
    90 
   105 
    91 3. For tree-sitter modes, grammars install automatically when first opening a file
   106 3. Jinx spell-checker will compile its native module on first launch (requires enchant)
       
   107 
       
   108 4. For tree-sitter modes, grammars install automatically when first opening a file
    92 
   109 
    93 ## Tree-sitter Support
   110 ## Tree-sitter Support
    94 
   111 
    95 Tree-sitter provides faster, more accurate syntax highlighting and parsing. Enabled automatically for:
   112 Tree-sitter provides faster, more accurate syntax highlighting and parsing. Enabled automatically for:
    96 - JavaScript/TypeScript
   113 - JavaScript/TypeScript