Skip to content

LloydProof is a system for tracking errors discovered while proofreading.

License

Notifications You must be signed in to change notification settings

bjnord/lloyd_proof

Repository files navigation

LloydProof is a system for tracking errors discovered while proofreading. The client app captures errors found while reading, and uploads them to the server app which manages the list of needed corrections.

LloydProof is in very early development; it’s currently at the “simplest thing that could possibly work” stage.

Installation

The server is written in Ruby on Rails. It can be installed on a host with Ruby 1.9 in the usual way; at this stage, there’s nothing to configure except the database:

$ bundle install
[edit config/database.yml]
$ rake db:schema:load
$ rails server

Accessing /corrections on the server will show the corrections uploaded so far (initially blank).

The Android client is currently targeted at API level 14 (Android 4.0 “Ice Cream Sandwich”) and above. If you have the Android SDK and tools installed, you can build it in the usual way:

$ cd android
[set ANDROID_HOME environment variable, or see local-example.properties]
$ ant [ debug | release ]

Then install the .apk file from android/bin onto your Android device. (By default the Android client uses the server at 10.0.2.2:3000 which works for a localhost Rails server and the Android emulator. You can change the server URL in the client settings.)

As you proofread, you can select text in the reading app, and then use Android’s “Share via” to send the text directly to LloydProof without a copy-paste step.

Future Goals

  • Users, authentication, and authorization

  • Projects (grouping corrections by works being proofread)

  • Android 2.3.3 “Gingerbread MR1” (API level 10)

  • Full correction lifecycle management

  • Browser-based client app (e.g. Google Chrome plugin)

Feedback

I’ve created this project, in part, to train myself in good coding practices I have been learning recently. Any feedback is welcome! Please feel free to contact me at lloydproof@nordist.net, or add bugs or suggested features to the GitHub issue tracker if they aren’t there already.

Copyright and License

Copyright © 2012 by Brent J. Nordquist. Some Rights Reserved.

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

About

LloydProof is a system for tracking errors discovered while proofreading.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published