doomemacs/modules/lang/csharp/README.org

79 lines
2.2 KiB
Org Mode
Raw Normal View History

# -*- mode: doom-docs-org -*-
#+title: :lang csharp
#+subtitle: Unity, .NET, and Mono shenanigans
#+created: February 20, 2017
#+since: 2.0.0
* Description :unfold:
This module adds C# support to Emacs, powered by Omnisharp (directly or through
2019-09-26 14:20:25 -04:00
LSP).
2018-02-04 05:05:32 -05:00
** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
- +dotnet ::
Enable Dotnet transient interface with Sharper
- +lsp ::
Enable LSP support for ~csharp-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports =omnisharp-roslyn=).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
- +unity ::
Enable special support for the [[https://unity.com/][Unity game engine]] (particularly, support for
HLSL shaders).
** Packages
- [[doom-package:][csharp-mode]]
- [[doom-package:][csproj-mode]]
- [[doom-package:][shader-mode]] if [[doom-module:][+unity]]
- [[doom-package:][sharper]] if [[doom-module:][+dotnet]]
- [[doom-package:][sln-mode]]
2020-12-08 19:39:32 +00:00
** Hacks
/No hacks documented for this module./
2018-02-04 05:05:32 -05:00
** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./
* TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
This module requires:
- Mono (on UNIX platforms)
- .NET SDKs (on Windows)
- .NET Core 1.X - 3.X or .NET 5 for cross platform
- omnisharp-rosyln (if [[doom-module:][+lsp]])
2018-02-04 05:05:32 -05:00
2019-09-26 14:20:25 -04:00
** TODO MacOS
2018-02-04 05:05:32 -05:00
** Arch Linux
#+begin_src sh
pacman --needed --noconfirm -S mono
#+end_src
2019-09-26 14:20:25 -04:00
** TODO NixOS
* TODO Usage
#+begin_quote
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* TODO Configuration
#+begin_quote
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote
* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]
* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
* TODO Appendix
#+begin_quote
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote