Skip to content

Commit

Permalink
docs(README): add section on contributing a new platform
Browse files Browse the repository at this point in the history
  • Loading branch information
DOD-101 committed Jan 18, 2025
1 parent 089a888 commit 7ad63d3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,12 @@ require('nordic').setup({

For the list of supported plugins, please take a look at [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/groups/integrations.lua). For the list of supported platforms, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms).

I do not personally use all of the platforms and plugins in the list, so if something is not right, or you have a suggestion, please open a PR!
## Contributing a new Platform

All of the platform files are generated using a template system. Have a look at the files in [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/lua/nordic/platforms) to see how it works.

> [!NOTE]
> I don't personally use all of the platforms and plugins in the list, so if something is not right, or you have a suggestion, please open a PR!
# 🎙️ Acknowledgements

Expand Down

0 comments on commit 7ad63d3

Please sign in to comment.