From 5c91775d644f7d6efc9ed0974017dfbeeb67d85b Mon Sep 17 00:00:00 2001 From: Dave Hulihan Date: Sun, 18 Mar 2012 15:55:09 -0600 Subject: [PATCH] Removed README.textile, updated README.md, removed old odd/even row bgs --- README.md | 48 ++++---- README.textile | 153 ------------------------ public/themes/fracture/images/row_a.png | Bin 266 -> 0 bytes public/themes/fracture/images/row_b.png | Bin 335 -> 0 bytes 4 files changed, 25 insertions(+), 176 deletions(-) delete mode 100755 README.textile delete mode 100755 public/themes/fracture/images/row_a.png delete mode 100755 public/themes/fracture/images/row_b.png diff --git a/README.md b/README.md index fc064b2..96e1a43 100644 --- a/README.md +++ b/README.md @@ -8,27 +8,29 @@ Opal has a a lot of features. Maybe too many. Feast your eyes on these: * System * Powered by Ruby on Rails 3.2 - * Easy-to-use TinyMCE content editor with security filtering and image uploader - * State-of-the-Art Interface powered by HTML5, CSS3, jQuery, Uploadify, and jQuery TOOLS - * Customizable [Themes](http://customize.hulihanapplications.com/Projects/category/6-opal) & [Plugins](http://customize.hulihanapplications. com/Projects/category/11-opal with easy uploader & installer - * Mass file & image uploader - * Store uploaded files locally or in the cloud using Amazon S3, Rackspace Cloud Files, etc. - [(Guide)](http://dev.hulihanapplications.com/wiki/opal/Upload - * I18n(Internationalization) support for multiple languages & locales. Currently supported languages: + * Store uploaded files locally or in the cloud using Amazon S3, Rackspace Cloud Files, etc. - [(Guide)](http://dev.hulihanapplications.com/wiki/opal/Upload) + * I18n support for multiple languages & locales. Currently supported languages: * en * ru +* Interface + * Easy-to-use TinyMCE content editor with security filtering and image uploader + * State-of-the-Art Interface powered by HTML5, CSS3, jQuery, Uploadify, and jQuery TOOLS + * Mass file & image uploader + * Apply special effects to Images: Rotate, Resize, Watermark, Stamp, Monochrome, Sepia, etc. + * Customizable [Themes](http://customize.hulihanapplications.com/Projects/category/6-opal) & [Plugins](http://customize.hulihanapplications.com/Projects/category/11-opal) with easy uploader & installer * Items - * List Any Type of Item (Products, Video Games, Locations, Events, Classifieds, etc.) - * Add extra stuff to your Items like Images, Videos, Reviews, Comments, Files, Discussions, Custom Fields, and more. + * List Any Type of Item: Products, Video Games, Locations, Events, Classifieds, etc. + * Add extra stuff to your Items like Images, Videos, Reviews, Comments, Files, Discussions, Custom Fields, and more! * Infinite-depth category organization & customizable advanced item searching +* Pages + * CMS-style Page editing with File Uploader + * Integrate Blog System + * Advanced Page features: Group-only access, Redirection, Subpages, etc. * Users * Multiple-user login system with secure administration area * Login from other websites(facebook, twitter, google, etc.) with OpenID/OAuth Support - [(Guide)](http://dev.hulihanapplications.com/wiki/opal/OAuth) * User Activity Logging * Gravatar Support -* Images - * Apply special effects to Images(Rotate, Resize, Watermark, Stamp, Monochrome, Sepia, etc.) -* Pages - * CMS-style Page editing & Integrated Blog * [Much More](http://www.hulihanapplications.com/projects/opal) ## Uses @@ -42,20 +44,20 @@ Since Opal is highly customizable, you can use it for many different things: * File Download System * Forum/Discussion Board * Review/Classifieds Website -* E-Commerce Website/Web Store +* E-Commerce Website/Web Store (TBD)
-![Opal's User Interface](https://github.com/hulihanapplications/Opal/raw/master/themes/public/fracture/screenshot.png) +![Opal's User Interface](https://github.com/hulihanapplications/Opal/raw/master/public/themes/fracture/screenshot.png)
-# Getting Started +# Installation -## Get Opal +## Step 1 - Get Opal Opal is available at the following places: -* [Official Website](http://www.hulihanapplications.com/projects/opal) * [Github](https://github.com/hulihanapplications/Opal) +* [Official Website](http://www.hulihanapplications.com/projects/opal) If you have git installed on your server, you can install it directly from Github. This is highly recommended and makes updating Opal a breeze. @@ -63,7 +65,7 @@ If you have git installed on your server, you can install it directly from Githu git clone git://github.com/hulihanapplications/Opal.git ``` -## Install Gems +## Step 2 - Install Gems Install all of Opal's required gems using bundler: @@ -74,7 +76,7 @@ bundle install --without development test * You may get an error here regarding [magick](http://dev.hulihanapplications.com/wiki/opal/RMagick) if you don't have it already installed. Check out this [Wiki Guide](http://dev.hulihanapplications.com/wiki/opal/RMagick) for help. -## Install Opal +## Step 3 - It's time to rake Next, Run these commands (while in the Opal directory) to install Opal's required stuff (database structure, assets, etc.) in production mode: @@ -89,7 +91,7 @@ bundle exec rake db:sample RAILS_ENV=production LOCALE=en These commands will create the database structure of Opal in production mode. If you leave out *RAILS_ENV=PRODUCTION*, everything will be installed into your development database instead. This will also set up the default admin account, some sample items, and other stuff to help you get started with Opal. You can also specify the *LOCALE* variable to install Opal in a language other than english. -## That's it! +## Step 4 - Fire 'er up You can now start Opal using the 'thin' webserver... @@ -101,7 +103,9 @@ bundle exec rails s -e production * To log in to Opal for the first time, the default Admin username and password is: *admin*. -# Updating Opal +You've now successfully installed Opal. Go grab yourself a sandwich to celebrate. + +# Bonus Step: Updating Opal If you installed Opal with git, updating is a piece of cake. Go to your Opal directory and run these commands: @@ -111,8 +115,6 @@ rake db:migrate RAILS_ENV=production rake assests:precompile RAILS_ENV=production ``` -That's it! - # Extra Stuff ## Guides & Tutorials diff --git a/README.textile b/README.textile deleted file mode 100755 index 4de0ce0..0000000 --- a/README.textile +++ /dev/null @@ -1,153 +0,0 @@ -h1. Opal - -Opal is the swiss army knife of web apps. It's a powerful Item & Content Management System powered by Ruby on Rails. You can use Opal for blogging, listing items, storing files/images/videos, or for powering any awesome website. - -h2. Features - -* Powered by Ruby on Rails 3.2 -* List Any Type of Item (Products, Video Games, Locations, Events, Classifieds, etc.) -* Add extra stuff to your Items like Images, Videos, Reviews, Comments, Files, Discussions, Custom Fields, and more. -* Easy-to-use TinyMCE content editor with security filtering and image uploader -* Multiple-user login system with secure administration area -* Login from other websites(facebook, twitter, google, etc.) with OpenID/OAuth Support - "(Guide)":http://dev.hulihanapplications.com/wiki/opal/OAuth -* Mass file & image uploader -* Store uploaded files locally or in the cloud using Amazon S3, Rackspace Cloud Files, etc. - "(Guide)":http://dev.hulihanapplications.com/wiki/opal/Upload -* Apply special effects to Images(Rotate, Resize, Watermark, Stamp, Monochrome, Sepia, etc.) -* Infinite-depth category organization & customizable advanced item searching -* I18n(Internationalization) support for multiple languages & locales -* CMS-style Pages & Integrated Blog -* Customizable "Themes":http://customize.hulihanapplications.com/Projects/category/6-opal & "Plugins":http://customize.hulihanapplications.com/Projects/category/11-opal with easy uploader & installer -* User Activity Logging -* Gravatar Support -* State-of-the-Art Interface powered by HTML5, CSS3, jQuery, Uploadify, and jQuery TOOLS -* "Much More":http://www.hulihanapplications.com/projects/opal - -h2. Uses - -Since Opal is highly customizable, you can use it for many different things: - -* Content Management System(CMS) -* Directory Website -* Blog -* Image/Video Gallery -* File Download System -* Forum/Discussion Board -* Review/Classifieds Website -* E-Commerce Website/Web Store - -!https://github.com/hulihanapplications/Opal/raw/master/public/themes/fracture/screenshot.png(Opal's Default Theme - Fracture)! - -h1. How To Install Opal - -h2. Get Opal - -Opal is available at the following places: - -* "Official Website":http://www.hulihanapplications.com/projects/opal -* "Github":https://github.com/hulihanapplications/Opal - -If you have git installed on your server, you can install it directly from Github. This is highly recommended and makes updating Opal a breeze. - -
-git clone git://github.com/hulihanapplications/Opal.git
-
- -h2. Install Gems - -Install all of Opal's required gems using bundler: - -
-cd Opal
-bundle install --without development test
-
- -* You may get an error here regarding "rmagick":http://dev.hulihanapplications.com/wiki/opal/RMagick if you don't have it already installed. Check out this "Wiki Guide":http://dev.hulihanapplications.com/wiki/opal/RMagick for help. - -h2. Install Opal - -Next, Run these commands (while in the Opal directory) to install Opal's required stuff (database structure, assets, etc.) in production mode: - -
-bundle exec rake db:migrate RAILS_ENV=production LOCALE=en
-bundle exec rake db:seed RAILS_ENV=production LOCALE=en
-bundle exec rake assets:precompile RAILS_ENV=production 
-
-# Install Sample Items, Categories, etc.
-bundle exec rake db:sample RAILS_ENV=production LOCALE=en
-
- -These commands will create the database structure of Opal in production mode. If you leave out *RAILS_ENV=PRODUCTION*, everything will be installed into your development database instead. This will also set up the default admin account, some sample items and other stuff to help you get started with Opal. You can also specify the *LOCALE* variable to install Opal in a language other than english. - -h2. That's it! - -You can now start Opal using 'thin' webserver... - -
-bundle exec rails s -e production
-
- -...or any of your other favorite webservers: nginx, apache, mongrel, etc. - -* To log in to Opal for the first time, the default Admin username and password is: *admin*. - -h1. Updating Opal - -If you installed Opal with git, updating is a piece of cake. Go to your Opal directory and run these commands: - -
-git pull origin master # pull the latest stable version of Opal
-rake db:migrate RAILS_ENV=production
-rake assests:precompile RAILS_ENV=production
-
- -That's it! - -h1. Extra Stuff - -h2. Guides & Tutorials - -Here's just a few of the "many things":http://dev.hulihanapplications.com/wiki/opal/User%27s_Guide you can do with Opal: - -* "Set up OAuth Authentication to log in through other websites":http://dev.hulihanapplications.com/wiki/opal/OAuth -* "Use Amazon S3, Rackspace Cloud Files, etc. to store files":http://dev.hulihanapplications.com/wiki/opal/Upload -* "Create Custom Fields for Items":http://dev.hulihanapplications.com/wiki/opal/Create_Custom_Fields_for_Items -* "Configure Email & Notifications":http://dev.hulihanapplications.com/wiki/opal/Notifications -* "Add an ad banner To Opal":http://dev.hulihanapplications.com/wiki/opal/Adding_an_Ad_Banner_To_Opal -* "How to Watermark Uploaded Images":http://dev.hulihanapplications.com/wiki/opal/Watermarking_Uploaded_Images - -Check out the "Opal Wiki":http://dev.hulihanapplications.com/wiki/opal/User's_Guide for more. - -h2. Plugins & Themes - -You can easily extend and customize Opal with new plugins and themes. *Plugins* extend Opal's core functionality and *Themes* change the appearance of your Opal application. - -Opal has a small but dedicated community of designers and coders that create plugins and themes for public use. You can find them on the official "Opal website":http://hulihanapplications.com/projects/opal#5. Check out the guides below to make your own. - -h1. Community & Additional Help - -If you need any more help, check out these resources: - -* "User's Guide":http://dev.hulihanapplications.com/wiki/opal/User%27s_Guide -* "Wiki":http://dev.hulihanapplications.com/wiki/opal/ -* "Forum":http://dev.hulihanapplications.com/projects/opal/boards - -h1. Development & Contribution - -If you're interested in developing Opal or contributing a theme, plugin, or translation, check out the following: -* "Submit a bug or feature request":http://dev.hulihanapplications.com/projects/opal/issues -* "Source Code On Github":https://github.com/hulihanapplications/Opal -* "Developer's Guide":http://dev.hulihanapplications.com/wiki/opal/Developer%27s_Guide -** "Plugin Development Guide":http://dev.hulihanapplications.com/wiki/opal/Plugin_Development -** "Theme Development Guide":http://dev.hulihanapplications.com/wiki/opal/Theme_Development -** "Locale Development Guide":http://dev.hulihanapplications.com/wiki/opal/Locale_Development - -h1. License - -Opal is Licensed under the "Creative Commons Attribution 3.0 United States License":http://creativecommons.org/licenses/by/3.0/us/ . - -h1. Kudos - -Special Thanks goes to following: - -* "Yusuke Kamiyamane":http://p.yusukekamiyamane.com/ for his snazzy fugue icon set. -* The "jQuery Core Team":http://jquery.org/team for making javascript dance like a puppet. diff --git a/public/themes/fracture/images/row_a.png b/public/themes/fracture/images/row_a.png deleted file mode 100755 index 330f41b7c7b97bf132a7fe51461dfa63d83c8aa7..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 266 zcmeAS@N?(olHy`uVBq!ia0vp^B0!wN!3HGTRtuZ~QY^(zo*^7SP{WbZ0pxQQctjR6 zFmMZjFyp1Wb$@_@swJ)wCBgY=CFO}lsSLh}$wm3OsVSL>3T~N2spa`a*~JRJ5eh~I z1}5!gYt92Th=DXX7o{eaWaj57gkFSZ_haj9x&iJ zup!O---%P1%nxl;8SKvQ{chcTZ|2Q6bJMq$$>bH>uzVv^#%J9=_wc#I=NpRgaJSd} ZU>4P7Rps>6l?7VD;OXk;vd$@?2>^0rS)Bj? diff --git a/public/themes/fracture/images/row_b.png b/public/themes/fracture/images/row_b.png deleted file mode 100755 index 4910fa8f0abce694b126520a86d9c56b6243d38e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 335 zcmeAS@N?(olHy`uVBq!ia0vp^B0!wN!3HGTRtuZ~QY^(zo*^7SP{WbZ0pxQQctjR6 zFmMZjFyp1Wb$@_@swJ)wCBgY=CFO}lsSLh}$wm3OsVSL>3T~N2spa`a*~JRJ5eh~I z1}5!gYt92Th=DXX7o{eaWaj57gkW=M`pF`BV3)+FXO`!s4_%zO@`-DAeZA21*7(%gLt0f%|GWa3)2;5mdKI;Vst02CU0asU7T