Skip to content

Commit

Permalink
Editor support Documentation (#3132)
Browse files Browse the repository at this point in the history
depends on #3129 

cc @josh11b for review
  • Loading branch information
maan2003 committed Aug 23, 2023
1 parent ad42ef1 commit ff5fab8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
15 changes: 15 additions & 0 deletions utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,18 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

This directory collects tools and utilities that may be useful to both Carbon
developers and developers writing Carbon code.

## Editor Support

- [VSCode](./vscode/README.md)
- [Neovim](./nvim/README.md)
- [Vim](./vim/README.md)
- [IntelliJ](./textmate/README.md#intellij)
- [Atom](./textmate/README.md#atom)

### Other Editors

Any editor that supports Language server protocol and/or tree-sitter is
supported. The editor just needs to be configured manually.
`bazel build language_server` produces the language server binary.
`utils/treesitter` contains the treesitter grammar.
6 changes: 6 additions & 0 deletions utils/textmate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,20 @@ Clone the repository with Git and symlink/copy the `utils/textmate` directory to
any of the paths TextMate will search through (you can find these paths in the
TextMate documentation above).

## IntelliJ

If you are using IntelliJ or a IntelliJ Platform product, you can find
documentation on
[how to install TextMate bundles in IntelliJ](https://www.jetbrains.com/help/idea/textmate.html#import-textmate-bundles).
Clone the repository with Git and open the `utils/textmate` directory inside the
IntelliJ TextMate Bundle window.

## Atom

If you are using Atom, you can convert the bundle to an Atom-compatible one. See
[the Atom documentation on how to do that.](https://flight-manual.atom.io/hacking-atom/sections/converting-from-textmate/)

## Other

For other editors that support TextMate bundles you can consult your editors
documentation to see how to use the bundle.

0 comments on commit ff5fab8

Please sign in to comment.