README.md in umlaut-3.3.1 vs README.md in umlaut-4.0.0.beta1
- old
+ new
@@ -37,20 +37,22 @@
For complete step-by-step install instructions suitable even for the neophyte, see:
https://github.com/team-umlaut/umlaut/wiki/Installation.
The Rails/Umlaut super-concise expert summary is:
-* Rails 3.1+ (but not yet tested with Rails 4), ruby 1.9.3.
+* Rails 3.2+ (Rails 4.1+ highly recommended, Rails 3's days are numbered),
+* ruby 1.9.3+ (Consider ruby 2.0 or 2.1, 1.9.3's days are numbered)
-* gem 'umlaut'
+* `$ gem install umlaut`
+* Then run the umlaut app generator: `$ umlaut my_new_app`
+** That will make a new rails app
+** without spring or turbolinks
+** using mysql (sqlite3 does not work for umlaut)
+** it will add the umlaut gem to your app
+** and it will run umlaut's generator to add a couple more files to your app, equivalent of `$ rails generate umlaut:install`
-* `bundle install`
-
-* `$ rails generate umlaut:install`
-
-* mysql database strongly encouraged, sqlite3 probably won't work.
-
+* set up your db in config/databases.yml and run `rake db:migrate`
* configuration in `./config/umlaut_services.yml` and `./app/controllers/umlaut_controller.rb`
* Umlaut uses multi-threaded concurrency in a way incompatible with development-mode class reloading. You need cache_classes=false even in dev, the Umlaut install generator changes this for you.
## Add ons
@@ -63,11 +65,11 @@
| [`umlaut-primo`](https://github.com/team-umlaut/umlaut-primo) | Umlaut services to provide full text service responses, holdings, etc. from the Primo discovery solution. |
## Developing
-Only spotty test coverage, sorry, but we're trying to improve. Don't trust
+Some test coverage not yet complete, but we're trying to improve. Don't trust
if all tests pass everythings good, but if tests fail, that's an unacceptable
commit. Try to add tests with new features, although we understand when
nobody can figure out a good way to test (esp our legacy architecture).
Run tests with `rake test`.
@@ -87,6 +89,5 @@
## Listserv
You can join the umlaut listserv at:
https://groups.google.com/forum/#!forum/umlaut-software
-