README.md in geoblacklight-0.3.4 vs README.md in geoblacklight-0.4.0

- old
+ new

@@ -4,95 +4,43 @@ GeoBlacklight is a world-class discovery platform for geospatial (GIS) holdings. It is an open collaborative project aiming to build off of the successes of the Blacklight Solr-powered discovery interface and the multi-institutional OpenGeoportal federated metadata sharing -communities. We are currently in a collaborative design phase and -we're actively looking for community input and development partners. -More coming soon! +communities. We're actively looking for community input and development partners. -## Features +###[Installation](https://github.com/geoblacklight/geoblacklight/wiki/Installation) -* Text and spatial search with scoring formula -* Facet by institution, year, publisher, data type, access, format -* Facet by place, subject -* Sort by relevance, year, publisher, title -* Results list view icons and snippets -* Detail map view for WMS features -* Detail map view feature inspection -* Slugs -* Results list map view of bounding boxes -* WMS/WFS/WCS links -* Download Shapefile -* Download KML -* Download Metadata (for Stanford) -* Built-in sample Solr 4.10 index -* Search history +Creating a new GeoBlacklight application from the template -## TODO +``` +$ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight/master/template.rb +``` -* See https://github.com/geoblacklight/geoblacklight/issues -* See https://github.com/geoblacklight/geoblacklight-schema/issues +To install Solr (with Jetty) -## Development +``` +$ cd app-name +$ rake jetty:download +$ rake jetty:unzip +$ rake geoblacklight:configure_jetty +``` -To install a development instance of GeoBlacklight follow these instructions. +Or install with [Docker](https://github.com/geoblacklight/geoblacklight-docker) +For more information see the [installation guide](https://github.com/geoblacklight/geoblacklight/wiki/Installation) -Clone the repository (using `--recurse`) +###[Contributing](https://github.com/geoblacklight/geoblacklight/wiki/Contributing) - git clone --recurse git@github.com:geoblacklight/geoblacklight.git - -Download and configure `jetty` to run Solr - - rake jetty:download jetty:unzip - rake geoblacklight:configure_jetty - -Create a test app (created at `/spec/internal`) - - rake engine_cart:generate - -Boot `jetty` - - rake jetty:start - -Boot GeoBlacklight test app - - cd spec/internal - rake geoblacklight:solr:seed # to load sample documents into jetty Solr instance - rails server - -Run tests - - rake ci - -## Installation - -To bootstrap a new GeoBlacklight Rails application - - $ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight/master/template.rb - -To install Solr (with jetty) - - $ cd app-name - $ rake jetty:download - $ rake jetty:unzip - $ rake geoblacklight:configure_jetty - - -## Usage - -For a non-development instance: - -1. Populate a Solr 4.7 index with geoblacklight-schema documents -2. Configure your GeoBlacklight application's `config/solr.yml` to point to the Solr index -3. Configure your `config/environments` and `app/controllers/catalog_controller.rb` -4. `rails server` to run GeoBlacklight - -## Contributing - 1. Fork it ( http://github.com/my-github-username/geoblacklight/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request -Also, if you wish to ask questions or participate further, email the [GeoBlacklight Working Group](https://groups.google.com/forum/#!forum/geoblacklight-working-group) at geoblacklight-working-group@googlegroups.com. +Also, if you wish to ask questions or participate further, email the [GeoBlacklight Working Group](https://groups.google.com/forum/#!forum/geoblacklight-working-group) at [geoblacklight-working-group@googlegroups.com](mailto:geoblacklight-working-group@googlegroups.com). + +###[Development](https://github.com/geoblacklight/geoblacklight/wiki/Development) + +See the [development guide](https://github.com/geoblacklight/geoblacklight/wiki/Development) on our wiki for more information about setting up your development environment. + + +Please see the full documentation hosted on our Wiki [Wiki](https://github.com/geoblacklight/geoblacklight/wiki)