# VHDL-Tool

[VHDL-Tool](https://www.vhdltool.com/) provides a [language server](https://github.com/Microsoft/language-server-protocol) for the VHDL hardware description language. Using [atom-languageclient](https://atom.io/packages/atom-languageclient), this plugin makes VHDL-Tool's language server interface available from within Atom.

**This is beta quality code. Report bugs here: https://git.vhdltool.com/vhdl-tool/vhdl-tool/issues.**

To use this plugin, you must first [download](https://www.vhdltool.com/download) VHDL-Tool. See the requirements section.

For now, only Linux is supported.

## Features

* Syntax checking
* Go to definition
* Find references
* Browse file symbols
* Basic autocompletion

## Screenshots
![Syntax check and hover](https://git.vhdltool.com/vhdl-tool/vhdltool-atom/raw/master/images/hover-syntax.png)

## Requirements

Before using this plugin, you must ensure that the `vhdl-tool` binary is installed on your system. To install `vhdl-tool` and setup your environment, do the following:

1. Install this plugin.
2. Download the `vhdl-tool` binary from [here](https://www.vhdltool.com/download), make sure it has execute permissions, and put it somewhere in your $PATH.
3. Create a vhdltool-config.yaml configuration file for your project by following the instructions [here](https://www.vhdltool.com/configuration).
4. Install the [`language-vhdl`](https://atom.io/packages/language-vhdl) Atom plugin.
5. (Optionally) install [`nuclide`](https://atom.io/packages/nuclide). This package depends on [Nuclide](https://nuclide.io/) for a lot of its functionality and it should be installed for the best experience.
6. Launch Atom and open the folder containing the configuration file created in the previous step.

See also the instructions [here](http://www.vhdltool.com/atom).

## Known Limitations
* The go to definition and find references commands are not accurate in the presence of overloading. In the case of multiple overloaded identifiers with the same name, the type correct one may not be chosen.
* No VHDL 2008 support yet.

## Release Notes

### 0.1.0

Initial beta release of VHDL-Tool.