readme formatting, contribution updates

.gitignore

@@ -39,7 +39,7 @@ agate/settings/secret/*
 
 # Packages #
 ############
-# it's better to unpack these files and commit the raw source
+# it's better to unpack these files and commit the raw source              
 # git has its own built in compression methods
 *.7z
 *.dmg

README.md

@@ -3,9 +3,8 @@
 
 # Acoustic Glider Analysis Tools and Environment
 
-<img
-src="README_files/figure-gfm/fa-icon-bcbd573b0c4bf742a1242819bebaac28.svg"
-style="width:0.88em;height:1em" /> *Last Update: 05 Aug 2024*
+<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/regular/calendar-check.svg" style="width:0.88em;height:1em" />
+*Last Update: 14 Aug 2024*
 
 A collection of MATLAB-based tools for piloting passive acoustic
 gliders, processing glider positional and environmental data, and

README.rmd

@@ -10,12 +10,11 @@ knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"
 )
-library(fontawesome)
 ```
 
 # Acoustic Glider Analysis Tools and Environment
 
-`r fa(name = "calendar-check")` *Last Update: `r format(Sys.Date(), "%d %b %Y")`*
+<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/regular/calendar-check.svg" style="width:0.88em;height:1em" /> *Last Update: `r format(Sys.Date(), "%d %b %Y")`*
 
 A collection of MATLAB-based tools for piloting passive acoustic gliders, processing glider positional and environmental data, and analyzing glider-collected passive acoustic data, particularly for surveys of marine mammals.
 

docs/_quarto.yml

@@ -46,6 +46,8 @@ website:
         text: Convert acoustic files
       # - href: content/code.qmd
       #   text: Code in your files
+      - href: contribute.qmd
+        text: Contribute
       - href: acknowledgements.qmd
         text: Acknowledgements
 

docs/contribute.qmd

@@ -8,30 +8,38 @@ knitr::opts_chunk$set(
   collapse = TRUE,
   comment = "#>"
 )
-library(fontawesome)
 ```
 
 We welcome contributions from the passive acoustic glider community! If you would like to contribute to this repository, you can do so in a few ways: 
 
-### **If you find a bug...**
+### If you find a bug...
 
 Please [report an issue on GitHub](https://github.com/sfregosi/agate-public/issues/new){target='_blank'}. Please use the 'Bug report' template. 
 
-### **If you'd like to request a feature or suggest an enhancement...**
+### If you'd like to request a feature or suggest an enhancement...
 
 Please [report an issue on GitHub](https://github.com/sfregosi/agate-public/issues/new){target='_blank'}. There is a 'Feature request' template just for this purpose. 
 
-### **If you'd like to add a feature or fix a bug yourself...**
+### If you'd like to add a feature or fix a bug yourself...
 
 [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the `agate-public` repository. This will create a copy of the repository in your own GitHub account. You can clone this fork to your local machine to work with the toolbox and make changes directly to the code, but also continue to pull changes from the primary repository to stay up to date. Then, when you have a feature you'd like to contribute back to the main repository, you can use a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to incorporate those changes. 
 
 We are happy to help get folks set up with this process, so please reach out with any questions! 
 
+### Coding conventions
+
+Start reading the existing code to get a hang of our currenct conventions. 
+
+- Use `camelCase` for naming functions
+- Use `camelCase` or underscores `_` when naming variables 
+- Always put spaces around `=` when defining variables, after list items and function parameters (`[1, 2, 3]`, not `[1,2,3]`) and around operators (`x + 1`, not `x+1`)
+- Use `...` to extend function calls onto a second line if it runs beyond 76 characters
+
 For consistency in documentation, we ask that you use the following templates to create any new functions or scripts:
 
 #### New function
 
-Paste the below code into the top of the new function and updated as needed. Refer to existing functions in the `utils` folder for examples of what kind of detail to include. For consistency, use 'camelCase' for the function name. Include your name, contact info, and MATLAB version info which can be checked with `version`. 
+Paste the below code into the top of the new function and updated as needed. Refer to existing functions in the `utils` folder for examples of what kind of detail to include. Include your name, contact info, and MATLAB version info which can be checked with `version`. Use spaces for all alignment (not tabs!) to ensure it renders properly with MATLAB documentation pop ups. 
 
 ```matlab
 function output = newFunction(input)