Name | Modified | Size | Downloads / Week |
---|---|---|---|
readme_0.6.0.txt | 2015-07-14 | 4.3 kB | |
Totals: 1 Item | 4.3 kB | 0 |
/************************************************************************* ** Project Name : neko_namazu (aka neko) ** Program Name : neko ** Version : 0.6.0 beta ***----------------------------------------------------------------------- ** Date : 23 July 2009 ** Last release : 09/07/2015 ** Architecture details : ** ** connexDetails.cpp ---> Dialog window (settings details for Namazu) ** connexDetails.h ** ** helpBrowser.cpp ---> Dialog: application help text browser ** helpBrowser.h ** ** main.cpp ---> main ** mainwindow.cpp ---> Main window ** mainwindow.h ** ** XMLRead.cpp ---> Read XML File ** XMLRead.h ** ** connex.xml ---> xml file holding default & specific settings details. ** ** neko.pro ---> Qt project file ** neko.qrc ---> Qt resource file ** nekoI18n_xx.ts/qm ---> Qt i18n file (en, fr) ** ***----------------------------------------------------------------------- ** Description : ** This program is a GUI frontend for namazu: a full-text search engine (www.namazu.org). ** ***----------------------------------------------------------------------- ** Author : Patrick LUBIN ** e-mail : kim88@gmx.co.uk ** Copyrigth (c) Patrick LUBIN, 2009-2015 *********************************************************************** ** GNU GPL LICENCE: This file is part of the Neko project. ** ** NEKO 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. ** ** NEKO 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 NEKO. ** 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 Neko ? Neko is a GUI frontend for namazu: a full-text search engine (www.namazu.org) ii- Technology used Neko uses Digia Qt/C++ (http://www.qt.io/). --> version 5.4.1 (Linux release). iii- Why Qt ? Digia Qt offers the possibility to write code once and target multiple platforms. iv- Application security n/a --------------------------------- 1- INSTALLATION INSTRUCTIONS --------------------------------- This version requires Qt libraries. i- LINUX minimum requirement install Qt library ii- WINDOWS minimum requirement n/a iii- MAC OS minimum requirement n/a v- Install Copy the directory "neko" in /opt directory. then create a shortcut on your desktop: vi- Run LINUX: ./neko or through the shortcut created MS Windows: n/a MAC OS: n/a --------------------------------- 2- CONFIGURATION INSTRUCTIONS --------------------------------- The application is configured through the configuration dialog. There are four directories to set: 1- the namazu binary directorty (default: /usr/bin) 2- the namazu configuration directory (default: /usr/share/namazu/pl) (for namazu configuration please refer to the namazu documentation) 3- the directory where the documents are stored (called "Data mine", by default in your home directory) 4- the index directory (by default in your home directory) --------------------------------- 3- OPERATING INSTRUCTIONS --------------------------------- i- ii- iii- About menu for the application. iv- About menu for Qt. --------------------------------- 4- KNOWN BUGS --------------------------------- None reported at present time --------------------------------- 5- TROUBLESHOOTING --------------------------------- None at present time --------------------------------- 6- CHANGELOG --------------------------------- v-0.6.0: To do: [EndOfFile]