Shinrai Files

/*************************************************************************
** Project Name : Shinrai
** Program Name :	shinrai
** Version :	1.0.1
**
***-----------------------------------------------------------------------
** Date : 12 December 2010
** Last release : 30/10/2011
** Linked With :
** main.cpp						--->		main
** mainwindow.cpp				--->		Construct: main window
** mainwindow.h
** shinrai01Login.cpp			--->		Widget construct: Login
** shinrai01Login.h
** shinrai02Read.cpp			--->		Widget construct: Read data
** shinrai02Read.h
** shinrai02ReadTabAll.cpp		--->		Tab construct: Read all data
** shinrai02ReadTabAll.h
** shinrai02ReadTabShort.cpp	--->		Tab construct: Read shortlisted data
** shinrai02ReadTabAll.h
** shinrai02ReadTabCat.cpp		--->		Tab construct: Read data sorted by category
** shinrai02ReadTabCat.h
** shinrai03Edit.cpp			--->		Widget construct: Edit records
** shinrai03Edit.h
** shinrai04Create.cpp			--->		Widget construct: Create new record
** shinrai04Create.h
** shinrai05Delete.cpp			--->		Widget construct: Edit records
** shinrai05Delete.h
** DBConnexDetails.cpp			--->	   Construct: DB connection details pop up window (settings read from DBConnexion.xml)
** DBConnexDetails.h
** DBConnexion.cpp				--->		Connection to DB routines
** DBConnexion.h
** XMLRead.cpp					--->		Read XML File with arguments passed from another .cpp file
** XMLRead.h
** shinrai.qrc					--->		Construct icons & images
** shinrai.rc		 			--->		Application icon (only present for Krosoft release)
** qrc_shinrai.cpp				--->		System generated Construct icons & images
**
** shinraiDB.db					--->		SQLITE3 DB file 
** DBConnexion.xml				--->		xml file holding the default & specific DB connection settings
** cat.xml						--->		xml file holding categories.
**
***-----------------------------------------------------------------------
** Description :
** The purpose of this program is to manage IDs & passwords.
** Details to be stored in a SQLITE DB.
**
***-----------------------------------------------------------------------
** Author :	Kim
** e-mail :	kim88@gmx.co.uk
** Copyright (c) Kim, 2010-2011
***********************************************************************
**	GNU GPL LICENCE:	This file is part of Shinrai.
**	
**	Shinrai 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.
**	
**	Shinrai 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 should have received a copy of the GNU General Public License along with Shinrai.
**	If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/

********************************
TABLE OF CONTENT
********************************
0-	PRESENTATION
1-	INSTALLATION INSTRUCTIONS
2-	CONFIGURATION INSTRUCTIONS
3-	OPERATING INSTRUCTIONS
4-	KNOWN BUGS
5-	TROUBLESHOOTING
6-	CHANGELOG
*********************************

0-	PRESENTATION
---------------------------------
i-	What is Shinrai ?
Shinrai is a password manager application.
It gives the possibility to store URLs and credentials

ii-	Technology used ?
Shinrai uses Nokia Qt/C++ (http://qt.nokia.com).
--> version 4.7.2 used for the Linux release.
--> version 4.7.4 used for MS Windows release

Configuration can be customized using XML files.
Shinrai uses SQLITE3 database to store data (for portability).

iii-	Why Qt ?
Nokia Qt offers the possibility to write code once to target multiple platforms.
It is planned to release versions for Linux, Mac OS, MS Windows as well as Maemo/MeeGo (mobile phones)

iv-	"Shinrai", what does it mean ?
Shinrai is a japanese word.
Meanings: reliance, trust, faith, confidence
Romaji (english pronunciation): shinrai [ʃInlaI]

v-	Application security
Shinrai does not offer any access control yet.
This is mainly due to the SQLITE3 DataBase which does not allow encryption and therefore information contained in the DataBase file can be dumped.
Any access control routine would give a false impression of security, so nothing is implemented yet, until encryption is available.


1-	INSTALLATION INSTRUCTIONS
---------------------------------
i-	LINUX minimum requirement
install Qt library

ii-	WINDOWS minimum requirement
copy Qt DLLs to c:\WINDOWS\system32\
a copy of the DLLs may be downloaded from the Shinrai project:
http://sourceforge.net/projects/shinrai/files/win32/dll_4.7.3.7z
(7-zip is available from http://www.7-zip.org/)

iii-	MAC OS minimum requirement
***Not tested / not compiled [yet]***

iv-	Maemo/MeeGo minimum requirement
***Not tested / not compiled [yet]***

v-	Install
Copy the directory "shinrai" in any directory.

vi-	Run
LINUX:	shinrai
MS Windows: shinrai.exe
MAC OS: not implemented yet
Maemo/MeeGo: not implemented yet


2-	CONFIGURATION INSTRUCTIONS
---------------------------------
The configuration of Shinrai is made through XML files:

i-	DataBase access
Information is stored in DBConnexion.xml. The file can be modified through Shinrai or through direct editing of the file

ii-	"Category" details
information is stored in cat.xml. To customise, edit the file using common text editor.	

iii-	All data are stored in shinraiDB.db	(SQLITE3 file)


3-	OPERATING INSTRUCTIONS
---------------------------------
Shinrai is controled through menu and toolbar icons.

i-	Shinrai opens on a "logo" screen. It is planned to be a "login" screen but it is not implemented yet.

ii-	A "read" screen gives the possibility to access data through tabs

iii-	The next screen is for editing

iv-	The fourth screen is for adding records

v-	The fifth screen is for deleting records


4-	KNOWN BUGS
---------------------------------
None reported at present time

5-	TROUBLESHOOTING
---------------------------------
None at present time

6-	CHANGELOG
---------------------------------
v1.0.1: 
-> select entire row
-> select single row
-> sorting table by column

To do:
- Help file
- Interface translation
- Dynamic font selection
- Login process & data cryptography
- Installer

[EndOfFile]