Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README for new build system

  • Loading branch information...
commit 74bd24674a0e003e6a8e4e77c78e4980d414c3b0 1 parent 1b7a59d
@evanmiller evanmiller authored
Showing with 56 additions and 11 deletions.
  1. +23 −11 README.markdown → README.md
  2. +33 −0 README_UPGRADE
View
34 README.markdown → README.md
@@ -4,7 +4,18 @@ Getting Started With Chicago Boss
Quickstart
----------
-Dependencies:
+ make
+ make app PROJECT=mynewproject
+ cd ../mynewproject
+ ./start-dev.sh
+
+Then visit http://localhost:8001/ in your browser.
+
+There will be a lot of PROGRESS REPORTs but everything should be running smoothly.
+
+
+Dependencies
+------------
* Erlang R13A or later -
@@ -12,26 +23,27 @@ Dependencies:
* Check with `erlang:system_info(otp_release)`.
-Build Chicago Boss with `make`.
* On Windows Vista or Windows 7 -
1. you need install win openSSl (http://www.slproweb.com/products/Win32OpenSSL.html)
2. make mochiweb with msys or cygwin
-When you're ready to start the server, run `./START-DEV.SH` (or start-dev.bat)
-in this directory (admin privileges needed). There will be a lot of PROGRESS
-REPORTs which look scary but hopefully everything is running smoothly. With
-this console you can interact directly with the running server. Next, point
-your browser to:
- http://localhost:8001/
+Upgrades
+--------
+
+See README_UPGRADE
+
+
+Database Setup
+--------------
-If all is well you will see "Hello, World!" Now you can get busy.
+See README_DATABASE
-Documentation
--------------
+Developer Documentation
+-----------------------
See the FAQ and API files located at
View
33 README_UPGRADE
@@ -1,3 +1,36 @@
+Upgrade: From 0.5.x
+-------------------
+
+Starting with Chicago Boss 0.5, the framework source is kept separate from your
+project source. After downloading and building a new copy of CB, you need to update
+your server scripts to point to the new source. Open "start-dev.sh" and "start.sh"
+and make sure there is an argument like this:
+
+ -pa /path/to/new/ChicagoBoss/ebin
+
+You might also want to update your /admin interface by copying the "skel/admin"
+directory from the new CB over to your project directory.
+
+
+Upgrade: From 0.4 to 0.5
+------------------------
+
+The easiest way to upgrade from 0.4 is to create a new CB app and copy your source
+into it. In the CB source directory, type:
+
+ make
+ make app PROJECT=mynewproject
+ cd ../mynewproject
+ cp -a /path/to/existing/project/view \
+ /path/to/existing/project/model \
+ /path/to/existing/project/controller \
+ /path/to/existing/project/static \
+ /path/to/existing/project/boss.config \
+ .
+
+Then start the server with ./start-dev.sh
+
+
Upgrade: From 0.4.x to 0.4.y
----------------------------
Please sign in to comment.
Something went wrong with that request. Please try again.