Read Me

     //
  /////u  // //         craftware        ===============
   //    // //         utilities        Instructor 1.0
  // // // // // //                    ===============
 // // //  yt ///    www.utillyty.eu
             //

Quick and dirty lessons organizer.


                QUICK REFERENCE

                1. Release notes
                2. Install
                3. Usage records
                4. Licence
                5. Revisions history


1. Release notes
   =============

   version 0.2 2016-01-06

   first public release


2. Install
   =======

   Instructor is a portable app, i.e no setup is needed:
   if you've just unpacked the binary distribution double click on the
   'Instructor' file ('Instructor.exe' on Windows) and run it!


3. Usage records
   =============
   
   * Run from usb stick in linux

     By default usb stick are not mounted with exec permission.
     If you get a permission denied message, umount the usb stick and remount with:

         mount -o rw,exec,uid=1000,gid=1000,umask=022 /dev/sdb1 ~/usbstick


   * Insert or Update lesson
     -----------------------

     You can get this message:

         query error #19 columns pupil_id, l_num are not unique Unable to fetch row

     if the lesson number is already present for that pupil.
     Change the lesson number with one that as not already been used.


   * Delete a 'recovery' lesson
     --------------------------
      
     1) open the lesson in edit mode, cancel the "recovery" flag, and save.
     2) select the lesson and delete it.

     NOTE:

     If you skip step 1 you will get this message:

         query error #19 foreign key constraint failed Unable to fetch row 

     due to a FOREIGN KEY constraint on the 'lessons' table, whose field
     'a_recovery_id' references the 'id' field on the same table.


   * Delete a 'recovered' lesson
     ---------------------------
      
     1) delete the 'recovery lesson' following steps above.
     2) select the lesson and delete it.

     NOTE:

     If you skip step 1 you will get this message:

         query error #19 foreign key constraint failed Unable to fetch row 

     due to a FOREIGN KEY constraint on the 'lessons' table, whose field
     'a_recovery_id' references the 'id' field on the same table.


4. Licence
   =======

   Copyright (C) 2016 Attilio Pavone <tilly@utillyty.eu>

   Instructor is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   Instructor is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You can find a copy of the GNU General Public License in the file
   LICENSE.txt, or can see <http://www.gnu.org/licenses/>.

   This software uses the following open source libraries/resources:
   - Qt toolkit (http://www.qt.io) version 4.8
   - flaticons free icons (www.flaticons.com)


5. Revision history
   ================

   - version 0.2, 2016-01-04

     first public release