https://github.com/nverno/nand-hdl-mode

Emacs major mode for editing NAND hardware description language files (.hdl)
https://github.com/nverno/nand-hdl-mode

emacs hdl nand

Last synced: 3 months ago
JSON representation

Emacs major mode for editing NAND hardware description language files (.hdl)

• Host: GitHub
• URL: https://github.com/nverno/nand-hdl-mode
• Owner: nverno
• License: gpl-3.0
• Created: 2016-08-19T00:10:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-24T08:26:38.000Z (about 1 year ago)
• Last Synced: 2023-11-24T09:30:08.176Z (about 1 year ago)
• Topics: emacs, hdl, nand
• Language: Emacs Lisp
• Homepage:
• Size: 849 KB
• Stars: 13
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Emacs major mode for Nand2Tetris(NAND) hdl files (.hdl)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Emac major  mode for NAND  hardward description  language files (.hdl)  from the

coursera class nand2tetris.

See [jack-mode](https://github.com/nverno/jack-mode) for a Jack major-mode.

## The mode provides

- syntax / font-locking

- customizable indentation: choose indentation for IN/OUT declarations,

  PARTS, and general offset.

- Compilation support, running the chip in simulator, and jumping to mismatches

  in .out file.

- Comparison buffer for expected vs. output. (`C-c C-c`)

- imenu, other user functions, etc.

- Autocompletion / dropdown help using `company-nand` with

  `company-mode` and `company-quickhelp`

Tools in build directory:

- Autogenerate snippets from the HDL survival website (for use with yasnippet)

- Autogenerate docs.txt from builtin chips.

Todo:

- Completion-at-point functions.

- Jump to definitions

### Installation

Require this file or autoload mode / compile.

Snippets can be enabled by simply enabling `yas-minor-mode` in

`nand-hdl-mode-hook`.

The variable `nand-hdl-directory` needs to be set to point to

the installation directory of nand2tetris, ie the directory

containing 'tools' and 'projects' directories.

```lisp

;; Example

(require 'nand-hdl-mode)

(add-hook 'nand-hdl-mode-hook 'yas-minor-mode)

```

See `company-nand` for autocompletion setup.

![example](doc/example.png)