docs(:lang): update READMEs to new format
This commit is contained in:
parent
ca7579a1e9
commit
20cac97c08
61 changed files with 4261 additions and 2634 deletions
|
@ -1,43 +1,76 @@
|
|||
#+TITLE: :lang csharp
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::lang csharp][Issues]] ↖ [[doom-module-source:lang/csharp][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :lang csharp
|
||||
#+SUBTITLE: Unity, .NET, and mono shenanigans
|
||||
#+CREATED: February 19, 2019
|
||||
#+SINCE: 21.12.0
|
||||
|
||||
* Table of Contents :TOC:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#macos][MacOS]]
|
||||
- [[#arch-linux][Arch Linux]]
|
||||
- [[#nixos][NixOS]]
|
||||
|
||||
* Description
|
||||
This module adds C# support to Emacs. Powered by omnisharp (directly or through
|
||||
* Description :unfold:
|
||||
This module adds C# support to Emacs, powered by Omnisharp (directly or through
|
||||
LSP).
|
||||
|
||||
** Module Flags
|
||||
+ =+lsp= Enables omnisharp through LSP support (requires omnisharp).
|
||||
+ =+unity= Enables special support for the [[https://unity.com/][Unity game engine]] (particularly,
|
||||
support for HLSL shaders).
|
||||
+ =+dotnet= Enables Dotnet transient interface with Sharper
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/josteink/csharp-mode][csharp-mode]]
|
||||
+ [[https://github.com/omajid/csproj-mode][csproj-mode]]
|
||||
+ [[https://github.com/OmniSharp/omnisharp-emacs][omnisharp]]* (not =+lsp=)
|
||||
+ [[https://github.com/midnightSuyama/shader-mode][shader-mode]]* (=+unity=)
|
||||
+ [[https://github.com/sebasmonia/sharper][sharper]] (=+dotnet=)
|
||||
** 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=).
|
||||
- +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]]
|
||||
|
||||
* Prerequisites
|
||||
This module needs:
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
+ omnisharp (with the ~+lsp~ flag, this must be installed externally. Without
|
||||
it, use ~M-x omnisharp-install-server~)
|
||||
+ .NET SDKs (on Windows)
|
||||
+ Mono (on UNIX platforms)
|
||||
+ .NET Core 1.X - 3.X or .NET 5 for cross platform
|
||||
** 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]])
|
||||
|
||||
** TODO MacOS
|
||||
|
||||
** Arch Linux
|
||||
#+BEGIN_SRC sh
|
||||
sudo pacman --needed --noconfirm -S mono
|
||||
#+END_SRC
|
||||
#+begin_src sh
|
||||
pacman --needed --noconfirm -S mono
|
||||
#+end_src
|
||||
|
||||
** 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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue