doomemacs/modules/lang/nim/README.org

:lang nim

• Description
  • Maintainers
  • Module flags
  • Packages
  • Hacks
  • Changelog
• Installation
  • Nim
• Usage
• Configuration
• Troubleshooting
• Frequently asked questions
• Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

---

Description   unfold

This module adds Nim support to Doom Emacs.

• Code completion (nimsuggest + company)
• Syntax checking (nimsuggest + flycheck)
• Org babel support (ob-nim)

Maintainers

This module needs a maintainer. Become a maintainer?

Module flags

This module has no flags.

Packages

• flycheck-nim if :checkers syntax
• nim-mode

Hacks

• nimsuggest was modified to strip invalid characters from its temp file paths (which would break nimsuggest on Windows systems).
• nim-mode was modified to fail gracefully if nimsuggest (the executable) isn't available.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires:

• nim, for building & evaluation.
• nimsuggest, for code completion, syntax checking, and jump-to-definition functionality.

Nim

choosenim is an installer and version manager for the Nim programming language. You can install the latest stable release of Nim by running the following in your terminal and following the onscreen instructions:

curl https://nim-lang.org/choosenim/init.sh -sSf | sh

Alternatively, nim is usually available through your OS's package manager:

• MacOS: $ brew install nim
• Arch Linux: $ pacman --needed --noconfirm -S nim nimble
• openSUSE: $ zypper install nim

TODO Usage

🔨 This module has no usage documentation yet. Write some?

TODO Configuration

🔨 This module has no configuration documentation yet. Write some?

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?