README.md in trusty-cms-3.0.8 vs README.md in trusty-cms-3.0.9
- old
+ new
@@ -1,123 +1,93 @@
## Welcome to TrustyCMS
[](http://badge.fury.io/rb/trusty-cms)
-Trusty is a branch of the venerable Radiant CMS. Its goal is to pull the Radiant framework into Rails 4 with minimal changes to its infrastructure. Most of what is below is derived from the original Radiant CMS readme.
+TrustyCMS is a branch of Radiant CMS. Its goal is to pull the Radiant framework into Rails 5 with minimal changes to its infrastructure.
-TrustyCms is a no-fluff, open source content management system designed for
+TrustyCMS is a no-fluff, open source content management system designed for
small teams. It is similar to Textpattern or MovableType, but is a general
-purpose content management system (not just a blogging engine).
+purpose content management system (not just a blogging engine). TrustyCMS is a
+Rails engine and is built to be installed into an existing Rails 5 application as a gem.
-[](https://travis-ci.org/pgharts/trusty-cms/)
+TravisCI: [](https://travis-ci.org/pgharts/trusty-cms/)
-Currently, TrustyCMS is functional but still has some core issues. We're managing the outstanding problems in [Github Issues](https://github.com/pgharts/trusty-cms/issues?state=open), so if you'd like to help out, that's a great place to start. Also, if you find anything wrong, let us know there so we can get to work fixing it.
+CodeClimate: [](https://codeclimate.com/github/codeclimate/codeclimate)
+TrustyCMS features:
-TrustyCms features:
-
* An elegant user interface
-* The ability to arrange pages in a hierarchy
+* The ability to arrange pages in a hierarchy with drag and drop
* Flexible templating with layouts, snippets, page parts, and a custom tagging
- language (Radius: http://radius.rubyforge.org)
+ language
* A simple user management/permissions system
* Support for Markdown and Textile as well as traditional HTML (it's easy to
create other filters)
* An advanced plugin system
+* Social sharing buttons
* Operates in two modes: dev and production depending on the URL
* A caching system which expires pages every 5 minutes
-* Built using Ruby on Rails
-* And much more...
+* Built using Ruby on Rails (version 5)
## License
-TrustyCms is released under the MIT license. The Radiant portions of the
+TrustyCMS is released under the MIT license. The Radiant portions of the
codebase are copyright (c) John W. Long and Sean Cribbs; anything after the
fork is copyright (c) Pittsburgh Cultural Trust. A copy of the MIT license can
be found in the LICENSE file.
## Installation and Setup for Use
-TrustyCms is a traditional Ruby on Rails application, meaning that you can
-configure and run it the way you would a normal Rails application.
+TrustyCMS is a traditional Ruby on Rails engine, meaning that you can
+configure and run it the way you would a normal gem, like [Devise](https://github.com/plataformatec/devise).
-See the INSTALL file for more details.
+See the INSTALL.md file for more instructions.
-### Installation and Setup for Contributing to TrustyCms
+### Installation and Setup for Contributing to TrustyCMS
-#### Part A of setup, common to both kinds of installations
+#### Setup
Prerequisites:
-* A Github account and Git ([Github has some really good instructons](https://help.github.com/articles/set-up-git))
+* A Github account and Git ([Github has some really good instructions](https://help.github.com/articles/set-up-git))
+* Ruby 2.2.0 or higher
+* A Rails application (currently supports version 5.0)
+* Bundler
+* MySQL
+* [PhantomJS >= 1.8.1](https://github.com/teampoltergeist/poltergeist/tree/v1.5.0#installing-phantomjs)
Steps:
-1. Fork this repository to your github account.
+1. Fork this repository to your Github account.
1. Clone your fork to your machine.
1. `cd` into the directory you just cloned into.
+1. Follow the INSTALL.md instructions to setup an empty app with TrustyCMS installed. To modify TrustyCMS,
+point your dependency to the local path of your fork.
-#### Part B, the Vagrant install way
+ gem 'trusty-cms', path: '../trusty-cms'
-To get a development environment up and running quickly, we have a vagrant box with the dependencies you'll need! Just follow these steps:
+1. Set up your databases in your Rails application:
-1. Download and install [Vagrant](http://www.vagrantup.com/)
-1. Download and install [Virtualbox](https://www.virtualbox.org/)
-1. Download [this box](https://dl.dropboxusercontent.com/u/27379052/trusty-cms.box) into the directory with your code and make sure the file is named "trusty-cms.box".
-1. Run `vagrant up` to start the virutal environment
-1. Run `vagrant ssh` to ssh into the virtual environment
-1. `cd /vagrant` to get to the directory with the rails code that's shared with your computer.
-
-You can edit the files in this directory with your favorite editor on your
-machine. The files are shared into the `/vagrant` directory in the virtual
-machine.
-
-When you're done using the vagrant environment, you can run `vagrant destroy`
-to stop the vm and remove all guest hard disks. Next time you want to use it,
-just start from the `vagrant up` step again!
-
-#### Part B, the native install way to set up
-
-Prerequisites:
-
-* Ruby 2.2.0
-* The bundler gem
-* Mysql
-* [PhantomJS >= 1.8.1](https://github.com/teampoltergeist/poltergeist/tree/v1.5.0#installing-phantomjs)
-
-1. Install the gems with bundler: `bundle`
-
-#### Part C of setup, common to both kinds of installations
-
-1. Create a database configuration: `cp config/database.mysql.yml config/database.yml`. You probably don't need to make any further changes.
-1. Set up your databases:
-
bundle exec rake db:create
bundle exec rake db:migrate
- bundle exec rake db:migrate:extensions
- bundle exec rake db:test:prepare
1. Run the tests to make sure they pass (If they don't, file a bug!):
rspec
-1. Run `rails s` to start the server. Visit the site in your browser at http://localhost:3000.
-
When you're ready to make a change:
1. Add the pgharts fork as a git remote called "upstream": `git remote add upstream https://github.com/pgharts/trusty-cms.git` so that you can keep up with changes that other people make.
-1. Fetch the remote you just added: `git fetch upstream`
-1. Start a new branch for the change you're going to make. Name it something having to do with the changes, like "fix-queries" if you are going to try to fix some queries. Base this branch on `upstream/master` by running `git checkout -b fix-queries upstream/master`
+1. Fetch the remote you just added: `git fetch upstream`.
+1. Start a new branch for the change you're going to make. Name it something having to do with the changes, like "fix-queries" if you are going to try to fix some queries. Base this branch on `upstream/master` by running `git checkout -b fix-queries upstream/master`.
1. Make your changes and commit them. Please include tests!
1. Run the tests and make sure they pass.
-1. Push your changes to your github fork: `git push origin fix-queries`
-1. Send a pull request to the pgharts fork
-1. High five the nearest person!
+1. Push your changes to your github fork: `git push origin fix-queries`.
+1. Send a pull request to the pgharts fork.
-
## Support
-Most of the development for TrustyCms happens on Github:
+All of the development for TrustyCMS happens on Github:
https://github.com/pgharts/trusty-cms
TrustyCMS is supported in part by: