diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ed99ee7..8b9ad470 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. ## Basic Guidelines: -- Use Tabs to indent code, DO NOT USE SPACE. -- Use lowerCamelCase or underscores for naming Nasal variables/functions (someFunction, some_function). -- Comments optional for XML, mandatory for Nasal. +- Use Tabs to indent code +- Use lowerCamelCase for naming Nasal variables/functions (someFunction) +- Please document your code! - Do not add a comment to every line, only to functions/groups of code. - Remove .bak or .blend files, unless absolutely needed. - Leave one extra line at the bottom of each file. diff --git a/README.md b/README.md index e9538fd9..38206505 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ To install navdata, create a folder FMSDATA, and add it to your additional scene ## Installation If you have issues installing, please check INSTALL.MD! +Specifically, make sure you remove -dev from the folder name! ## External tools Some external tools you might want to checkout and use with this Model.