OSDN Git Service

Try to correct a problem when saving a note where unprintable characters would be...
[neighbornote/NeighborNote.git] / install.txt
1 Welcome to NixNote.     
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 (although I use it on Windows with no problems).
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 installed.  Depending upon your distribution this may be installed via a package manager or just installing NeverNote may cause Java to be downloaded & installed. This product is tested on Oracle/Sun Java
12
13  
14 =================================
15 =================================
16 ==  LINUX INSTALL INSTRUCTIONS ==
17 =================================
18 =================================
19
20 * NOTE:
21 Only i386 & amd64 are currently supported.  This is due to the fact that Qt Jambi only has prebuilt i386 & amd64 versions.  If you wish to use this on another platform, then you'll need to build Jambi for yourself.  If you do, please post a message on the user forums & I'll distribute it with later builds.  I don't have access to other platforms or I'd probably do it myself.
22
23
24 *********************************************************
25 *** Debian or Debian based systems (including Ubuntu) ***
26 *********************************************************
27 1.) Download the appropriate version (i386 or amd64).
28 2.) Issue dpkg -i <package> 
29
30
31 ************************
32 *** RPM ased systems ***
33 ************************
34 --NOTE: I used Alien to create these, so I'm not too sure how usable they are.
35 1.) Download the appropriate version (i386 or amd64).
36 2.) Issue rpm -ivf <package> 
37
38
39
40 ************************
41 *** Manual install   ***
42 ************************
43 1.) Download the appropriate binary file (i386 or amd64).
44 2.) As root, run the installation program.  It should walk you through the rest.
45
46
47
48 ************************
49 *** Manual install   ***
50 ************************
51 1.) Download the appropriate version (i386 or amd64).
52 2.) Unzip the files to a local directory.
53 3.) As root, issue ./install.sh
54
55
56
57 ===========================
58 ===========================
59 ==  WINDOWS INSTRUCTIONS ==
60 ===========================
61 ===========================
62 1.) Download the Windows installer.  It doesn't matter if you are running 64 or 32 bit since the install program has the needed packages for both.
63 2.) Run the install.  You shouldn't need administrator access.
64
65
66
67
68 =============================
69 =============================
70 == MAC OS-X   INSTRUCTIONS ==
71 =============================
72 =============================
73 -- NOTE: I don't have OS-X so I can't verify the stability or usability of this under OS-X
74 1.) Download the Mac install version.
75 2.) Run the install program.
76 3.) Run nixnote.sh from the installation directory.
77
78
79
80
81 =====================
82 ==  Configuration  ==
83 =====================
84 There are additional options if you wish to run multiple copies under the same userid and options which impact how Java works.  These settings are optional and, depending upon your needs, you probably don't need to touch them. 
85
86 To run under multiple IDs, you need to pass a parameter NN_NAME="<name>" to the nixnote.sh shell script where <name> is whatever name you want to identify this instance as.  For example, ./nixnote.sh NN_NAME="test" will create a separate database called "test".  Anything you put in there will be separate from the default NeverNote database, so the username can also be different.
87
88
89
90
91 ==========================
92 == To Build From Source ==
93 ==========================
94 To build from source package, you need several additional  utilities and developers kit.
95
96   JDK:
97        Java standard developers distribution.  you can download it from http://www.java.com/
98        or as Linux  package
99
100   lupdate, lrelease (not needed if you use Eclipse & don't want to wory about non-English translations): 
101        translation helper  ulitilites
102        These tools is bundled with qtjambi distribution where bin/ directory of qtjambi 
103
104
105
106 ***************************
107 ** To Build With Eclipse **
108 ***************************
109
110 There are sample project files and classpath definitions
111 in the source tree, but basically you need to import the source, add all the jar files to your path, & build.  The Jambi jar files you need to run it under eclipse will depend upon the platform (32 or 64 bit) you are using.  
112
113
114 **************************
115 * Build by command line  * 
116 **************************
117
118 To build without Eclipse IDE, you need to prepare 'ant' utility.
119  
120  - Compile and build  jar file
121
122    $ ant jar
123
124  - Update translation files
125
126    $  ant update-tr
127
128  - Clean binaries and temporary files
129
130    $ ant clean
131        or
132    $ ant all-clean
133  
134  - edit translations
135   
136     please see translations/README
137
138