Permalink
Browse files

checkpoint

  • Loading branch information...
1 parent 933751b commit 9bc94a13c93cb60289a07218734355a24978bccf Dale Henrichs committed Apr 22, 2012
Showing with 61 additions and 4 deletions.
  1. +11 −4 bin/README.md
  2. +41 −0 packages/README.md
  3. +9 −0 projects/README.md
View
@@ -1,8 +1,10 @@
-### Amber-Skeleton scripts
+### Amber Skeleton scripts
#### amberServer
-Launches the pharo image that acts as the file server for amber.
+Launches the pharo image that acts as the file server for amber. The
+root directory for the Amber File server is the root directory of the
+**Amber Skeleton** project.
#### makeAmberServer
@@ -11,5 +13,10 @@ Makes the `amberServer` pharo image. See the README in the
#### launchServer
-Common script for launching the pharo vm. For now you need to edit the
-script to add the path to your pharo vm.
+Common script for launching the pharo vm. The expects the shell
+variable `$AMBER_PHARO_VM` to point to the Pharo vm executable.
+
+This script `cd's` to the `server/pharo` directory and launches the pharo vm, consequently `FileDirectory default` is the `server/pharo` directory, as it should be.
+
+The Amber install script arranges for the Amber server root to be the
+root directory of the **Amber Skeleton** project.
View
@@ -0,0 +1,41 @@
+#Amber Skeleton projects directory
+
+This is where you save your source in [Cypress package format][1].
+
+###Export
+To **export** Amber source for a new project as a Cypress package:
+
+```Smalltalk
+AmberProjectExporter
+ registerPackage: 'MyPackageName'
+ type: 'cypress'
+ prefix: 'packages/'
+```
+
+Once the package is registered with the `AmberProjectExporter`,
+subsequent `Commits` of the package will be written as a Cypress package
+in the `packages/` directory.
+
+### Import
+To **import** Amber source saved as a Cypress package:
+
+```Smalltalk
+CypressAmberImporter
+ importCypressPackages: #('MyPackageName')
+ prefix:'packages/'
+```
+
+You can include the above expression in the `ready: option` of the `loadAmber()` function in your `index.html` file:
+
+```javascript
+ smalltalk.CypressAmberImporter._importCypressPackages_prefix_(
+ [
+ 'MyPackageName',
+ ],
+ 'packages/');
+```
+
+The `CypressAmberImporter` automatically registers the package
+`MyPackageName` with the `AmberProjectExporter`.
+
+[1]: https://github.com/CampSmalltalk/Cypress
View
@@ -0,0 +1,9 @@
+#Amber Skeleton projects directory
+
+This is where you include `git submodule` references to your dependent
+projects.
+
+See [Working with submodules][3] for more information about using submodules.
+
+[3]: http://help.github.com/submodules/
+

0 comments on commit 9bc94a1

Please sign in to comment.