PSModelViewer

PSModelViewer is an iPad application that allows you to browse a Core Data model on the go. Simply drop in a Core Data model and build.

View the Project on GitHub epreston/PSModelViewer

PSModelViewer

PSModelViewer is an iPad application that allows you to browse a Core Data model on the go. Simply drop in a Core Data model and build.

Example Data Model

This application includes a moderately complex Core Data model to demonstrate the usage of this tool.

Status

PSModelViewer is a rough yet workable solution for instantly creating an interactive reference for Core Data development work. It is meant to be quickly updated with minimum effort and rebuilt each time the data model changes.

This project follows the SemVer standard. The API may change in backwards-incompatible ways before the 1.0 release.

The goal of PSModelViewer is to build an application that consumes an unmodified Core Data model and presents browsable representation of its' structure. This is intended to be a mobile / interactive reference during development.

Documentation

You can generate documentation with doxygen. The example project includes a documentation build target to do this within Xcode. For more details, see the Documentation page in this projects wiki.

Contribute

If you'd like to contribute to PSModelViewer, start by forking this repository on GitHub:

http://github.com/epreston/PSModelViewer

The best way to get your changes merged back into core is as follows:

  1. Clone down your fork
  2. Create a thoughtfully named topic branch to contain your change
  3. Hack away
  4. Add tests and make sure everything still passes
  5. If you are adding new functionality, document it in the README
  6. Do not change the version number, I will do that on my end
  7. If necessary, rebase your commits into logical chunks, without errors
  8. Push the branch up to GitHub
  9. Send a pull request to the epreston/PSModelViewer project.

Copyright and License

Copyright 2010 Preston Software.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.