language-servers/mcshader-lsp
1
0
Fork 0
mirror of https://github.com/Strum355/mcshader-lsp.git synced 2025-08-31 05:47:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added to readme and made a contributing.md

Browse source
This commit is contained in:
Noah Santschi-Cooney 2018-05-17 00:06:45 +01:00
parent 5578674b10
commit a341d66dda
No known key found for this signature in database
GPG key ID: 3B22282472C8AE48
2 changed files with 33 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,25 @@
# Contributing
Want to contribute? I sure want you to! Heres how you can help:
## Setting up environment
Development requirements (did I miss any? Submit a PR!):
`npm, nodejs, tslint, VSCode`
Fork the repo (you are using [SSH keys](https://help.github.com/articles/connecting-to-github-with-ssh/), right?):
`git@github.com:Strum355/vscode-mc-shader.git`
Install dependencies:
`cd vscode-mc-shader && npm i`
## Submitting a Pull Request
Please adhere to the following guidelines before submitting a pull request:
- Passes tslint checks with the given config.
- Provide some comments in the code (see mine as an example).
- Provide a good explanation of the changes provided. This helps me follow your code better.

11
README.md
View file

@ -18,15 +18,20 @@ Got a feature request? Chuck it into an Issue!
## Requirements
- Visual Studio Code of course
- Not MacOSX. Not that you're making MC Shaders on/for MacOSX anyways...right?
- Visual Studio Code (v1.17.0 or higher - untested)
- The [Shader languages support for VS Code](https://marketplace.visualstudio.com/items?itemName=slevesque.shader) extension. This should automatically install when you install this extension
- The [OpenGL / OpenGL ES Reference Compiler](https://cvs.khronos.org/svn/repos/ogl/trunk/ecosystem/public/sdk/tools/glslang/Install/) (for convenience, put it in your PATH)
- The [OpenGL / OpenGL ES Reference Compiler](https://cvs.khronos.org/svn/repos/ogl/trunk/ecosystem/public/sdk/tools/glslang/Install/) (for convenience, put it in your PATH, this is the assumed location if not specified). If, for some reason, you're using MacOS, there are no pre-compiled binaries of this.
- [Windows] An up to date version of Windows with Developer mode enabled for symlink support. (May not always work, I've gotten inconsistent results)
- [MacOS] Not MacOS. Not that you're making MC Shaders on/for MacOS anyways...right?
## Extension Settings
- `mcglsl.glslangValidatorPath` : The path to the glslangValidator executable. If not provided, it assumes its in your `PATH`.
## Contributing
Please see [CONTRIBUTING.md](https://github.com/Strum355/vscode-mc-shader/blob/master/CONTRIBUTING.md).
## Known Issues
I'll fill this in once this actually gets released.