install.txt

   1 Welcome to NeverNote.
   2
   3 This is a very basic clone of Evernote designed to run on Linux.
   4 It is written in Java so it will also run on other platforms as well but the primary focus has been to try
   5 and get a usable environment for Linux.
   6
   7 See release.txt for details of what works and what doesn't work.
   8
   9 --- Requirement ---
  10
  11 Before trying, please be sure you have Java 1.6 and QT Jambi 4.5 and later versions installed.
  12
  13  - Java
  14    Java will probably be installed via a package manager. This product is tested on Oracle/Sun Java
  15    1.6 and OpenJDK 6.
  16
  17  - QtJambi
  18    Jambi is a implementation of Qt GUI library on Java environment.
  19    You'll probably need to download QT Jambi from  http://qtjambi.sourceforge.net/
  20    or http://qt.qualtech.com/download
  21    This product is tested agains qtjambi 4.5.2_01 now.
  22
  23 The only thing you need to do with Jambi is to have the files untarred to a directory.
  24 You'll need to edit the install scripts to point to this directory (the instructions are below).
  25 People have used this with both 64 & 32 bit versions of Linux as well as OpenJDK & Sun's Java
  26 and (so far) have not encountered any problems with these different environments.
  27
  28
  29 --- To Install ---
  30
  31 1.) Extract binary distribution package on a directory.
  32      If you use Linux/Unix OS,  you may prefer to extract it in ~/NeverNote
  33      If you use MS-Windows, you may extract it in D:/NeverNote
  34
  35     Some archive managers do not untar all subdirectories properly because some of the subdirectories
  36     are initially empty.  After untarring, you should see a lib, res, images, db, qss, and logs directories
  37     directly under the nevernote directory.
  38     Some of these will be empty until you begin running the program.
  39
  40 2.) Edit nevernote.sh (for Linux) or nevernote.bat (for Windows) in this directory.
  41      At the top of the file there will be 4 variables.
  42 2-1.) Edit the NEVERNOTE variable to point to the full path of where you installed NeverNote.
  43 2-2.) Edit the JAMBI_LOCATION variable to point to the full path of where QT Jambi was installed.
  44 2-3) Edit the JABBI_VERSION variable to indicate the proper QT Jambi version you have installed.
  45      I've tested with 4.5 only.  I don't think older versions will work.
  46 2-4.) Edit the JAMBI_PLATFORM variable to indicate the Linux/Windows platform you are running.
  47
  48 3.)  Launch nevernote.sh (for Linux) or nevernote.bat (for Windows) to start
  49
  50 4.)  Enjoy!
  51
  52
  53
  54 --- Configuration ---
  55
  56 There are additional options if you wish to run multiple copies under the same userid.
  57 These settings are optional and, depending upon your needs, you probably don't need to touch them.
  58
  59 Thera are also additional options to tune a performance of Java Virtual Machine. If you do not aware,
  60 don't touch it. If you use recent multi-core and high performance CPU, its change may improve
  61 a performance.
  62
  63 Please see either nevernote.sh or nevernote.bat for details.
  64
  65
  66 --- Run ---
  67
  68 If you've read this far and have done everything described above then you're done.  You should be
  69 able to run the nevernote.sh (or nevernote.bat for Windows) script and start things up.
  70 The initial synchronize will take a while depending upon the amount of data.
  71
  72 This prgram has the ability to synchronize against production servers as well as sandbox servers
  73 or to use multiple accounts under the same Linux/Windows ID.
  74 Please see the startup script for details if you wish to run multiple copies under the same Linux or
  75 Windows userid.
  76
  77 DO NOT MIX PRODUCTION & SANDBOX DATA IN THE SAME DATABASE OR HAVE
  78 MULTIPLE USER ACCOUNTS IN THE SAME DATABASE!
  79
  80 Using the same database to store both production & sandbox data or multiple Evernote accounts
  81 will cause problems.      If you wish to run multiple copies of NeverNote you must have separate
  82 installation directories for each and you MUST edit the startup scripts and give any one
  83 after the first a separate name.  By default, it will try to use the sandbox servers.
  84 If you wish to use production data you can change this under the Edit/Preferences directory option.
  85
  86 You must change this BEFORE your first synchronization with Evernote.
  87
  88 --- Build from source ---
  89
  90 1. Directories and pre-requisite
  91
  92 Source package contains several directories.
  93
  94  src/    java soruce files
  95  lib/    dependent Java libraries
  96  qss/    GUI design definitions
  97  images/ icons and logos
  98  xml/    a protocol definition in XML
  99  translations/   localized message catalogs
 100
 101 To build from source package, you need several additional  utilities and developers kit.
 102
 103   JDK:
 104        Java standard developers distribution.  you can download it from http://www.java.com/
 105        or as Linux  package
 106
 107   lupdate, lrelease:
 108        translation helper  ulitilites
 109        These tools is bundled with qtjambi distribution where bin/ directory of qtjambi
 110
 111 2. Build on Eclipse Integrated Development Environment
 112
 113 <TBD>
 114
 115 There are sample project files and classpath definitions
 116 in the source tree.
 117
 118
 119 3. Build by command line
 120
 121 To build without Eclipse IDE, you need to prepare 'ant' utility.
 122
 123  - Compile and build  jar file
 124
 125    $ ant jar
 126
 127  - Update translation files
 128
 129    $  ant update-tr
 130
 131  - Clean binaries and temporary files
 132
 133    $ ant clean
 134        or
 135    $ ant all-clean
 136
 137  - edit translations
 138
 139     please see translations/README
 140
 141
 142 --- Caution!!! ----
 143
 144 Please remember this is beta software.  As such, you can expect to encounter problems.
 145 Also please note that until I get to version 1.0 I do not guarantee clean upgrades.
 146 This means I may ask you to delete everything & start over when upgrading.  This can cause you
 147 to lose any unsynchronized data.  I really hope to not need to do this and will try to provide upgrades
 148 if possible, but it is a matter of time versus effort.  Since only a few people are using it I don't want to
 149 put in an enormous amount of time to do clean upgrades.  If this causes a lot of heartache
 150 please let me know and I'll try to provide something better.
 151