Massive overhaul of Spin standard library

Author: bweir

CONTRIBUTING.md

@@ -0,0 +1,158 @@
+# Spin Standard Library Style Guide
+
+Traditionally, Spin has been difficult for inexperienced developers to start with.
+This has to change for it to be taken seriously as an educational platform.
+
+This guide has been written to aid in developing a consistent, accessible out-of-the-box
+experience of the Spin language.
+
+## Submissions
+
+New object submissions should include demos for readily available reference
+hardware. For example:
+
+*   Sample code that runs as-is on a Propeller HYDRA
+*   Sample code and a circuit schematic for running the code on a Propeller Activity Board
+
+## Organization
+
+The Spin Standard Library is organized into the following folder structure.
+
+    .
+    └── library
+        ├── demos
+        ├── examples
+        └── templates
+
+#### library/
+
+The top-level of the library that will be included with PropellerIDE. All core object additions go here.
+Anything above this level is not distributed.
+
+##### demos/
+
+These files are organized hierarchically based on the object they demonstrate. For example, let's say we
+have the following module.
+
+    com.serial.fullduplex
+
+You should be able to find sample code for it in the following location:
+
+    com/serial/FullDuplex.spin
+
+Or if there are multiple examples:
+
+    com/serial/fullduplex/ThisDemo.spin
+    com/serial/fullduplex/ThatDemo.spin
+
+##### examples/
+
+Not all sample code fits neatly into one object or another. For more complex demonstrations that may
+use many different objects, the `examples/` folder is used.
+
+This is a good place for demonstrations that will run as-is on a given piece of hardware.
+
+##### templates/
+
+Files included in `templates/` will be available within PropellerIDE's "New From Template" feature. These are 
+named how they will appear, with spaces replaced with underscores. Therefore, "Awesome Template v1.0"
+should be saved as:
+
+    Awesome_Template_v1.0.spin
+
+## Style
+
+Owing to Spin's similarity to Python, for topics not covered here, please refer
+to [PEP-8](https://www.python.org/dev/peps/pep-0008/) where appropriate.
+
+In no particular order:
+
+*   Skip one line after declaring a block and before starting a new one; no more, no less.
+
+    Yes:
+
+        PUB Foo
+
+            Bar
+
+        PUB Biz
+
+            Boo
+
+    No:
+
+        PUB Foo
+            Bar
+        PUB Biz
+        
+
+
+            Boo 
+
+*   Use **4** spaces for indentation.
+
+*   Always *indent* inside of blocks. Existing Spin compilers do not require this
+    but failing to do so produces hard-to-read code.
+
+    Yes:
+
+        PUB Foo
+
+            Bar
+            Baz
+
+    No:
+
+        PUB Foo
+
+        Bar
+        Baz
+      
+*   Treat all files as case-sensitive. Spin does not require this but it is good practice
+    anyway.
+
+*   Always capitalize the same way.
+
+      *   Blocks and constants are upper-case (`PUB`, `CON`, ...).
+
+      *   Variables, labels, and non-block keywords are lower-case (`offsetx`, `temp`, ...).
+
+      *   Function names are CamelCase (`DoSomething`, `EnableFeature`, ...).
+
+*   Avoid extraneous spaces in code.
+
+*   Avoid excessive commenting; only comment individual lines of code when necessary.
+
+*   **Do not** add licensing stubs or header information. This information is automatically
+    added to software releases from the repository itself.
+
+*   **Do** add documentation comments after function block declarations. These will be
+    rendered into documentation in later PropellerIDE releases.
+
+        PUB ThisFunction(val, val2)
+        '' This is an interesting function
+
+            HereIsTheCode
+            MoreCode(val2)
+            val += 2
+
+*   Do not use Parallax font-specific special characters or in-source schematic diagrams.
+    This feature is not portable and will be removed from PropellerIDE in the future.
+    PropellerIDE will eventually support markdown syntax in documentation, so it is
+    recommended to draw pictures of any diagrams and add them to a folder called `images/`
+    in the same folder as the object.
+
+    For an illustration in a core object:
+
+        com.serial.fullduplex.spin
+        images/com/serial/fullduplex/img1.png
+
+    For a demo object:
+
+        com/serial/fullduplex/FullDuplex.spin
+        com/serial/fullduplex/images/img1.png
+
+## Questions?
+
+Please submit any questions or feedback you have to the
+[issue tracker](https://github.com/parallaxinc/spin-standard-library/issues). 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Brett Weir
+Copyright (c) 2015 Parallax Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

License.spin

@@ -1,6 +1,21 @@
-The Spin Standard Library
-=========================
+# The Spin Standard Library
 
-This project contains a collection of Spin code to get your Propeller up and running and doing interesting things.
+The Spin Standard Library is designed to be a definitive starting point for Spin programming. It contains a
+curated collection of Spin objects that have been organized and formatted for consistency, with a
+wide array of functionality represented. 
 
-This library is part of the [PropellerIDE project](https://github.com/parallaxinc/PropellerIDE).
+The project is a part of the [PropellerIDE project](https://github.com/parallaxinc/PropellerIDE).
+
+## Contributing
+
+Please read the [guidelines](CONTRIBUTING.md) before submitting a pull request.
+
+## Testing
+
+You can compile every file in the project with the following script.
+
+    ./scripts/test.sh
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).