emacs.d/README.org

3.3 KiB

A Personal Emacs Configuration

This is my personal Emacs configuration, continually used and tweaked since 2020, and I am always trying to make it same behaviour on my Windows and macOS.

Usage

TODO

Setup

Basically, following the The Dependencies section is enough to set up.

If you're a big fan of Portable Software on Windows Platform like me, please refer to Windows Platform: Portable Software Integration.

Key Bindings

Key Bindings are managed by general.el, and the bindings configuration can be found from here.

The Dependencies

Flycheck

Python

I use python-flake8 as Python checker, refer to requirements.txt.

Shell

I use sh-shellcheck as Shell checker, refer to this link for installation.

YAML

I use yaml-yamllint as YAML checker, refer to requirements.txt.

For Windows Platform Specifics

I started using Scoop to manage some of my apps, including,

  • Aspell

    scoop bucket add iquiw_scoop-bucket https://github.com/iquiw/scoop-bucket
    scoop install aspell

    (Aspell can also be implemented by MSYS2, refer to this link.)

  • Prettier

    scoop install nodejs
    npm install -g prettier
  • ShellCheck

    scoop install shellcheck
  • shfmt

    scoop install shfmt

For macOS Platform Specifics

Aspell

Use below command to install aspell,

brew install aspell

Windows Platform: Portable Software Integration

Flycheck

Portable Python - WinPython

For the packages are installed in a portable Python like WinPython, executable paths should be configured manually.

python-flake8

I.e.,

(setq flycheck-python-flake8-executable "V:/WPy32-3810/python-3.8.1/Scripts/flake8.exe")
yaml-yamllint

I.e.,

(setq flycheck-yaml-yamllint-executable "V:/WPy32-3810/python-3.8.1/Scripts/yamllint.exe")

WinPython

WinPython is a portable distribution of the Python programming language for Windows.