deon/glava
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add prefix guidelines

Browse Source
This commit is contained in:
Jarcode
2019-04-02 17:18:41 -07:00
parent 8cb183fb9a
commit a15292be64
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -35,6 +35,8 @@ If you use GNU Emacs, the above style can be configured via the following elisp:
If you author and maintain your own shader module for GLava, you are free to use your preferred code style. Otherwise, shaders follow the same style as GLava's C sources. If you author and maintain your own shader module for GLava, you are free to use your preferred code style. Otherwise, shaders follow the same style as GLava's C sources.
The only exception to this is a hard rule for builtin prefixes. Variables should _never_ start with an underscore, as `__` are reserved by the GLSL compiler, and `_` are reserved for GLava builtins and namespaces.
## Pull Requests ## Pull Requests
You are free to make pull requests for any change, even if you are not sure if the proposed changes are appropriate. @wacossusca34 and/or @coderobe will be able to suggest changes or commentary on the PR if there is a reason it is not acceptable. You are free to make pull requests for any change, even if you are not sure if the proposed changes are appropriate. @wacossusca34 and/or @coderobe will be able to suggest changes or commentary on the PR if there is a reason it is not acceptable.

2
glava.c
View File

@@ -182,7 +182,7 @@ static const char* help_str =
" appropriate backend will be used for the underlying windowing\n" " appropriate backend will be used for the underlying windowing\n"
" system.\n" " system.\n"
"-a, --audio=BACKEND specifies an audio input backend to use.\n" "-a, --audio=BACKEND specifies an audio input backend to use.\n"
"-p, --pipe=BIND[:TYPE] binds a value to be read from stdin. The input my be read using\n" "-p, --pipe=[BIND[:TYPE]] binds value(s) to be read from stdin. The input my be read using\n"
" `@name` or `@name:default` syntax within shader sources.\n" " `@name` or `@name:default` syntax within shader sources.\n"
" A stream of inputs (each overriding the previous) must be\n" " A stream of inputs (each overriding the previous) must be\n"
" assigned with the `name = value` syntax and separated by\n" " assigned with the `name = value` syntax and separated by\n"