diff --git a/README.md b/README.md index 2c3a156..11767fb 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,34 @@ -#ICEcoder -##Web IDE / browser code editor awesomeness +# ICEcoder + +## Web IDE / browser code editor awesomeness ICEcoder is a web IDE / browser based code editor, which allows you to develop websites directly within the web browser. It uses the brilliant CodeMirror for code highlighting & editing, with a slick IDE wrapped around it to make the whole thing work. ICEcoder web IDE -###Requirements +### Requirements + You can run ICEcoder either online or locally, on Linux, Windows or Mac based platforms. The only requirement is to have PHP 5 available (5.3 recommended). You can have this either as a vanilla installation or via a program such as WAMP or XAMPP (for Windows) or MAMP (for Mac). -###Installation +### Installation + +#### Step 1: Get ICEcoder -####Step 1: Get ICEcoder Either download the zip or clone from Github using: ``` $ git clone git://github.com/mattpass/ICEcoder ``` -####Step 2: Place in your document root (online or local) +#### Step 2: Place in your document root (online or local) + * Put in a new sub-dir URL such as yourdomain.com/ICEcoder or localhost/ICEcoder * Set write permissions (757 or 775 depending on your system) on the 'backups', 'lib', 'plugins', 'test' and 'tmp' folders *(Note: A small number of web servers give an internal server error here, if you get this, try 755 instead)* -####Step 3: Start coding +#### Step 3: Start coding + * Visit the sub-dir URL in your browser and enter a password **Now you're setup, auto-logged in and ready to code!**