https://github.com/ericnantel/vim-z80-docs

Unofficial Zilog Z80 Assembly Documentation
https://github.com/ericnantel/vim-z80-docs

assembly documentation neovim plugin retro vim z80 z80asm zilog

Last synced: 27 days ago
JSON representation

Unofficial Zilog Z80 Assembly Documentation

• Host: GitHub
• URL: https://github.com/ericnantel/vim-z80-docs
• Owner: ericnantel
• License: bsd-3-clause
• Created: 2024-08-10T03:46:38.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T20:45:55.000Z (2 months ago)
• Last Synced: 2024-09-28T15:21:13.306Z (about 1 month ago)
• Topics: assembly, documentation, neovim, plugin, retro, vim, z80, z80asm, zilog
• Language: Vim Script
• Homepage: https://github.com/ericnantel/vim-z80-docs
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The unofficial Zilog Z80 Assembly Documentation

*Written by Eric Nantel*

The primary intent of this (Neo)Vim plugin is to be able to efficient browse

for Z80 instructions within (Neo)Vim ecosystem, thus removing the need to launch

an external application.

# Installation

To install in Vim using vim-plug:

```vim

call plug#begin('~/.vim/plugged')

  Plug 'ericnantel/vim-z80-docs'

call plug#end()

```

To install in Neovim using lazy.nvim:

```lua

require("lazy").setup({

  spec = {

    {

      "ericnantel/vim-z80-docs",

    },

  }

})

```

# Search keyword

In order to open the unofficial Zilog Z80 Assembly Documentation within (Neo)Vim,

You can enter the one the following commands:

```vim

:help z80-docs

:help z80-registers

:help z80-instructions

```

To search for a specific instruction you may do a command like:

```vim

:help z80-instruction-add

```

Where you can replace 'add' by the instruction you are looking for.

If it exists, you'll be teleported to the right location in the doc.

# Contribution

I am looking for contributors for extending the unofficial Zilog Z80 Assembly Documentation.

Such as translators, and people that can report typos I may have made or that can add some

tables or graphs to help users visualize the architecture of its components (ex: RAM, ALU).

In addition to that, I am not against having tutorials on writing and/or assembling a program.

# What's next ?

Having a Z80 LSP in (Neo)Vim would be awesome !

But regarding this plugin, I want to make it simple for users to know about cycles an instruction

takes, so adding Z80 support to airline or lualine is something I am considering.

Additionaly, I would like to do other (Neo)Vim unofficial Doc plugins for other retro cpus.

If you read all this, congrats ! You may want to star this repository to help the retro community.

*Eric Nantel*