From 53714d07f7a25294e2f32a03fc063cecb49c1c86 Mon Sep 17 00:00:00 2001 From: Caleb Figgers Date: Wed, 23 Nov 2022 14:36:41 -0600 Subject: [PATCH] Updated README and LICENSE --- LICENSE.md | 2 +- README.md | 34 ++++++++++++++++++++++++---------- 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index a478e3e..81145a9 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016 Allen Huang +Copyright (c) 2022 Caleb Figgers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 9a38397..cf50984 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,38 @@ # Hy Language Support for Visual Studio Code -This extension add Hy language support to VS Code. + +## Introduction + +This extension adds [Hy language](https://www.github.com/hylang/hy) support to VS Code. Features (presently) include basic syntax highlighting and the ability to evaluate expressions by sending them to a Hy REPL. + ![](https://raw.githubusercontent.com/xuqinghan/vscode-hy/master/images/syntax_hy.PNG) -Hy is a wonderful dialect of Lisp that’s embedded in Python. -[https://github.com/hylang/hy](https://github.com/hylang/hy) +Features: +- [x] Basic syntax highlighting +- [x] Basic Hy code snippets +- [x] Code evaluation shortcuts -![](https://raw.githubusercontent.com/xuqinghan/vscode-hy/master/images/hy-logo-small.png) +Planned features: +- [ ] Improved syntax highlighting +- [ ] Auto-formatting on edit (esp. auto-indentation) +- [ ] [Paredit](https://www.emacswiki.org/emacs/ParEdit)-style structural editing based on S-expressions (slurping, barfing, dragging, killing, rewrapping, splicing, raising, navigation, auto-balancing for parens and other wrappers `[({""})]`) +- [ ] Intellisense code completion for built-in Hy functions and macros -to get colorful brasket, install [Rainbow Brackets](https://marketplace.visualstudio.com/items?itemName=2gua.rainbow-brackets) +## Installation +### Local Install +1. Navigate to your local .vscode (or .vscodium) extension directory (e.g. `$ cd ~/.vscode/extensions`) +2. Clone this repo within that directory (e.g. `git clone https://www.github.com/hylang/vscode-hy`) +3. Reload or relaunch any open VS Code/VS Codium windows -## Credits -This extension fork and reedit from a repo that sjhuangx's vscode-scheme to enable syntax on vscode. -[https://github.com/sjhuangx/vscode-scheme](https://github.com/sjhuangx/vscode-scheme) +## Contribution + +Issues and pull requests welcome. -This extension use a file that egrachev's sublime-scheme to enable syntax on vscode. +## Credits -[https://github.com/egrachev/sublime-scheme/blob/master/Scheme.tmLanguage](https://github.com/egrachev/sublime-scheme/blob/master/Scheme.tmLanguage) +This extension is a fork and reedit of Allen Huang's [xuqinghan/vscode-hy](https://github.com/xuqinghan/vscode-hy) extension: Copyright (c) 2016 Allen Huang **Enjoy!**