cmtool 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,92 @@
+= Cmtool
+
+This project rocks and uses MIT-LICENSE.
+== About
+Cmtool is a CMS to give you a quickstart for a website using CouchDB as database
+backend. It is in developing stage, but already used in production.
+It is designed as an engine. The thought behind is that you will have to
+create your own rails website, but get a lot of stuff for free. These things are:
+
+* User management
+* Page management
+* Faq
+* News
+* Newsletter subscriptions
+* Directory manager
+* Image manager
+
+== Setup
+To start using Cmtool as website CMS add it to your Gemfile. Since it 
+depends on github gems and gem dependencies do not support those you
+have to explicitly add two dependencies to your Gemfile:
+  gem 'couch_potato' , :git => 'git://github.com/bterkuile/couch_potato.git'
+  gem 'simply_stored' , :git => 'git://github.com/bterkuile/simply_stored.git'
+  gem 'cmtool'
+This will add some gems you might like anyway, here a list:
+
+* bourbon
+* jquery-rails
+* tinymce-rails
+* sass-rails
+* haml-rails
+* paperclip
+* email_validator (validates :email, email: true)
+
+=== User model
+The user model is important. We recommend you to create your own user model:
+  class User
+    include Cmtool::User
+
+  end
+This is enough to start using Cmtool. But probably you want to add some goodies of your own.
+Remember that this is a SimplyStored model with almost all the ActiveModel features.
+
+=== Page model
+The page model allows you to control some interesting things. To create it (app/models/page.rb):
+  class Page
+    include Cmtool::Page
+
+    # Define the locales you want to use in your website
+    def self.locales
+      [:en]
+    end
+
+    # Define the layouts you want to use in your website. Be sure to create them in
+    # app/views/layouts/...
+    # The first specified layout will become the default
+    def self.layouts
+      [:application, :home, :contact]
+    end
+  end
+ 
+=== Controlling the language of the system
+If you add a method <tt>cmtool_locale</tt> to your application controller
+Cmtool will take this value:
+  class ApplicationController
+    before_filter :set_locale
+
+    private
+    
+    def set_locale
+      # Do some magic
+      I18n.locale = :en
+    end
+
+    def cmtool_locale
+      I18n.locale
+    end
+  end
+=== Customize a page
+All pages by default are rendered using the view: app/pages/show. So adding and changing this file will
+change all displayed pages without their own specific page. To create a specific page, create a page
+with the name of the page you created in the Admin section. If for example you have created a page
+with the name: about
+Then you can give this page a custom look using the view:
+<tt>app/views/about.html.haml</tt>
+You can also use erb, slim or your choice of templating engine
+
+=== Customize your 404
+You can customize what is shown when a page cannot be found. There is a standard view app/pages/404.html.erb with the following content:
+ <%= render template: 'pages/show' %>
+Overwrite this to get another page as show. To controll the content of the 404 page, create a page in the Admin area having the name: 404. 
+You can make a 404 page for every language in this manner. Here you can also give a custom layout if you do not want to use the default layout.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cmtool'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test