Update README / CONTRIBUTING
This commit is contained in:
parent
9f7dd74a96
commit
30799c7de0
2 changed files with 4 additions and 3 deletions
|
@ -3,9 +3,9 @@
|
||||||
These examples will show the Guidelines for contributing. Please follow this at all times, or your contribution will not be merged.
|
These examples will show the Guidelines for contributing. Please follow this at all times, or your contribution will not be merged.
|
||||||
|
|
||||||
## Basic Guidelines:
|
## Basic Guidelines:
|
||||||
- Use Tabs to indent code, DO NOT USE SPACE.
|
- Use Tabs to indent code
|
||||||
- Use lowerCamelCase or underscores for naming Nasal variables/functions (someFunction, some_function).
|
- Use lowerCamelCase for naming Nasal variables/functions (someFunction)
|
||||||
- Comments optional for XML, mandatory for Nasal.
|
- Please document your code!
|
||||||
- Do not add a comment to every line, only to functions/groups of code.
|
- Do not add a comment to every line, only to functions/groups of code.
|
||||||
- Remove .bak or .blend files, unless absolutely needed.
|
- Remove .bak or .blend files, unless absolutely needed.
|
||||||
- Leave one extra line at the bottom of each file.
|
- Leave one extra line at the bottom of each file.
|
||||||
|
|
|
@ -23,6 +23,7 @@ To install navdata, create a folder FMSDATA, and add it to your additional scene
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
If you have issues installing, please check INSTALL.MD!
|
If you have issues installing, please check INSTALL.MD!
|
||||||
|
Specifically, make sure you remove -dev from the folder name!
|
||||||
|
|
||||||
## External tools
|
## External tools
|
||||||
Some external tools you might want to checkout and use with this Model.
|
Some external tools you might want to checkout and use with this Model.
|
||||||
|
|
Loading…
Reference in a new issue