Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated instructions (readme and readme_upgrade)

  • Loading branch information...
commit 5e1f4a1862c73a023a816448c05d534f9a2f5182 1 parent aead473
@jgordor jgordor authored
Showing with 63 additions and 4 deletions.
  1. +4 −4 README.md
  2. +59 −0 README_UPGRADE
View
8 README.md
@@ -16,14 +16,14 @@ After downloading and extracting, type
make
make app PROJECT=mynewproject
cd ../mynewproject
- ./start-dev.sh
+ ./init-dev.sh
Then visit http://localhost:8001/ in your browser. Congratulations, you have
a web server. There will be a lot of PROGRESS REPORTs on your console but
everything should be running smoothly.
The project name should be a legal Erlang atom, i.e. start with a lowercase
-letter and contain only letters, digits, and underscores.
+letter and contain only letters, digits, and underscores (for easy compatibility is recommended name the project dir and app name the same).
Dependencies
@@ -211,9 +211,9 @@ See the FAQ and API files located at
<http://www.chicagoboss.org/>
-If you need help getting started, check out "An Evening With Chicago Boss":
+If you need help getting started, check the new pdf tutorial:
-<http://www.evanmiller.org/chicago-boss-guide.html>
+<http://www.chicagoboss.org/tutorial.pdf>
There's also the mailing list:
View
59 README_UPGRADE
@@ -1,3 +1,62 @@
+Upgrade: From 0.6 to 0.7
+------------------------
+
+In Chicago Boss 0.7, projects are now rebarified, boss.config is the central place for all configuration and eunit testing has been made easy,
+
+bc. ./rebar boss # (list of available commands)
+./init.sh # (list of available boot commands)
+
+h3. Migrate current cb apps
+
+In order to ease the task, a new make task has been created in the framework Makefile, just update your Chicago Boss and run:
+
+bc. make rebarize APPDIR=/path/to/app
+
+This will copy all new files in your app directory, move the app.src file to src, move the boss_web_tests (functionals) to src/test/functional and point you with instructions on what you need add to your boss.config.
+
+bc. make rebarize APPDIR=../my_app
+../my_app rebar-boss-ified
+WARNING: your boss.config have not been changed, you need to set:
+- in boss app section:
+---- {path, "/path/to/chicago_boss"}
+---- {vm_cookie, "my_secret_cookie"} % Optional, defaults to abc123
+- for each app defined:
+---- {path, "../path/to/app"}
+INFO: you can safely remove the Makefile and start* files from your app dir
+INFO: after the boss.config change, you can run:
+cd ../my_app
+./rebar boss # Shows all boss-rebar commands
+./init.sh # Shows the new boot system commands
+
+h3. Compilation
+
+Boss has non-standard-compatible-rebar-way of compiling code, the rebar plugin switches off standard compilation and calls the boss_load module.
+
+./rebar compile (works for compatibility mode)
+./rebar boss c=compile
+
+h3. Configuration
+
+Now the only file on a cb project you need to take care is boss.config, the new init.sh calls ./rebar boss commands that returns automatically generated erl -pa... commands and executes it.
+
+You now defines the path in boss.config for each app and (compilation, test launch, start, stop, reload, ...) works automatically.
+
+A new setting in boss.config called vm_cookie (optional) has been added, used in start/stop/reload commands (defaults to "abc123"):
+
+bc. [{boss, [ {path, "../ChicagoBoss"}, {vm_cookie, "abc123"}, ...
+
+h3. Tests
+
+Eunit testing compilation/setup works automatically, start writing unit tests, just place them in "src/test/eunit" and run ./rebar eunit or ./rebar boss c=test_eunit
+
+Functional tests lives now in src/test/functional (before was placed in src/test), just call ./rebar boss c=test_functional
+
+h3. Init
+
+The init.sh handles start, start-dev as before, but also stop, reload (hot for the node) and restart is implemented.
+
+Now we can tweak, change, make vm.args configurable (in boss.config) without force developers to handle this manually in their apps.
+
Upgrade: From 0.5 to 0.6
------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.