diff --git a/style_guide.md b/style_guide.md index a12fe5f..ad53976 100644 --- a/style_guide.md +++ b/style_guide.md @@ -2,6 +2,8 @@ This script is a style guide for the ao-bash / ao-mud project and is not meant to be run. Please examine the file in a text editor. +This file represents the current moment of consensus for best practices or de facto policy for the ao-bash / ao-mud project. Please don't take it as the final word; if you would like to critique or improve this document and the best practices it contains, please do so. + # File Extensions Name scripts in the ao-bash suite without the `.sh` file extension. (Reason: When folders of ao-bash spells are added to the $PATH directory, the scripts can simply be called by name, without having to type `.sh` every time.) @@ -22,3 +24,10 @@ Name scripts in the ao-bash suite without the `.sh` file extension. (Reason: Whe ```ask_yn "Would you like a treatment?" Y``` +# Style References + +These projects and links provide a reference for the overall aesthetic approach of this project: + +- [An App Can Be a Home-Cooked Meal](https://www.robinsloan.com/notes/home-cooked-app/) +- [ao-3](https://github.com/autonomousorganization/ao-3) and [ao-react](https://github.com/coalition-of-invisible-colleges/ao-react/) +- [multiverse.plus](https://multiverse.plus) \ No newline at end of file