Add a README for all subprojects

api/README.md

@@ -0,0 +1,13 @@
+# solidus\_api
+
+API contains controllers and rabl views implementing the REST API of solidus.
+
+## Testing
+
+Create the test site
+
+ bundle exec rake test_app
+
+Run the tests
+
+ bundle exec rake spec

backend/README.md

@@ -0,0 +1,38 @@
+# solidus\_backend
+
+Backend contains the controllers, views, and assets making up the admin interface of solidus.
+
+## Assets
+
+### Javascript
+
+Can be found in [app/assets/javascripts/spree/backend/](./app/assets/javascripts/spree/backend/)
+
+Out scripts are written in a mix of coffeescript and javascript. We can't
+easily use a transpiler for ECMAScript >= 6 without adding additional steps for
+applications using solidus\_admin.
+
+As a result, we accept contributions in either plain-ol javascript or
+CoffeeScript, and discourage converting existing files.
+
+### Stylesheets
+
+Can be found in [app/assets/stylesheets/spree/backend/](./app/assets/stylesheets/spree/backend/)
+
+The stylesheets are written in SCSS and include all of [bourbon](http:https://bourbon.io/docs/) and [bootstrap 4 alpha](http:https://v4-alpha.getbootstrap.com/).
+
+When running the application there is a styleguide available at:
+
+```
+/admin/style_guide
+```
+
+## Testing
+
+Create the test site
+
+ bundle exec rake test_app
+
+Run the tests
+
+ bundle exec rake spec

core/README.md

@@ -0,0 +1,15 @@
+# solidus\_core
+
+Core contains all the models and the majority of the logic for the Solidus
+ecommerce system.
+
+
+## Testing
+
+Create the test site
+
+ bundle exec rake test_app
+
+Run the tests
+
+ bundle exec rake spec

frontend/README.md

@@ -1,11 +1,9 @@
-Core
-====
+# solidus\_frontend
 
-Core e-commerce functionality for the Spree project
+Frontend contains controllers and views implementing a storefront and cart for Solidus.
 
 
-Testing
--------
+## Testing
 
 Create the test site
 
@@ -14,8 +12,3 @@ Create the test site
 Run the tests
 
  bundle exec rake spec
-
-Run the coverage. After the rake task open coverage/index.html
-
- bundle exec rake rcov
-

sample/README.md

@@ -0,0 +1,22 @@
+# solidus\_sample
+
+Sample contains a set of test data which is used to generate the sandbox can be
+used to test out stores.
+
+Applications including the `solidus_sample` gem are provided a rake task to
+load the sample data:
+
+```
+bundle exec rake spree_sample:load
+```
+
+
+## Testing
+
+Create the test site
+
+ bundle exec rake test_app
+
+Run the tests
+
+ bundle exec rake spec