Skip to content

README.md

Latest commit

 

History

History
56 lines (38 loc) · 2.16 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.16 KB

blueprint-mode.el

A GNU Emacs major mode for GTK+ Blueprint files.

NOTE: This major mode is in its early stages. The syntax highlighting is done (albeit rudimentary in this author's opinion), and there are probably many things that this mode could be extended to do. I'm also not that good at elisp, so I welcome all the assistance I can get. - Dr. Bluefall

Usage

With straight.el:

(straight-use-package
    '(blueprint-mode :type git
                     :host github
                     :repo "DrBluefall/blueprint-mode"))

If you use LSP Mode, I recommend making sure to load the LSP integration with (require 'lsp-blueprint).

Contributing

If you want to work on blueprint-mode, I advise that you clone 2 additional repositories:

The latter has blueprint files from projects in the wild, which could prove useful for testing any features you intend to implement in blueprint-mode.

Speaking of testing, I suggest you test any changes you make to blueprint-mode under emacs -Q. For lsp-blueprint specificially, there is a setup-test.el file in the repository that you can use to install lsp-mode automatically from MELPA Stable.

TL;DR: emacs -Q -l blueprint-mode.el [-l setup-test.el -l lsp-blueprint.el]

LICENSE

Copyright (C) 2022 Alexander Bisono.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.