summaryrefslogtreecommitdiff
path: root/README.en.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.en.txt')
-rw-r--r--README.en.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/README.en.txt b/README.en.txt
new file mode 100644
index 0000000..cde04f3
--- /dev/null
+++ b/README.en.txt
@@ -0,0 +1,55 @@
+Copyright: (c) 2009 Dipl.-Inform. (FH) Paul C. Buetow
+WWW: http://netcalendar.buetow.org
+Mail: netcalendar@dev.buetow.org
+
+Quick howto for the NetCalendar
+
+How to start the NetCalendar stand alone:
+
+The command
+
+ "java -jar NetCalendar.jar --client-and-server"
+
+is starting the client and the server of the NetCalendar within the same
+process as two different threads. The option "server_address" will be set
+automatically to "localhost". The communication between both threads is done
+per TCP/IP.
+
+How to start the NetCalendar distributed:
+
+1. Server and client should use, if possible, the same version of the JRE.
+2. You should copy the complete NetCalendar suite to the client and the server
+computer.
+3. Start the server with "java -jar NetCalendar --server-only"
+4. Start the server with "java -jar NetCalendar --client-only \
+ --server-address=HOSTORIPOFTHESERVER"
+
+In order to stop the server, select "Server -> Shutdown server" in the GUI of
+the client.
+
+All options will be set to their default values while starting the NetCalendar
+without any explicit options given.
+
+If you want to see more available parameters, then run the command
+"java -jar NetCalendar --help"
+
+It is possible to configure the NetCalendar by editing the configuration file
+which is "config.txt". However, the preferred way is using the client GUI via
+"Session -> Preferences".
+
+Informations concerning the colors being used within the NetCalendar client:
+
+Blue in the "Date" column: Yearly event
+Green in the "Date" column: The event will take place only once
+
+Red: Event takes place within the next 24h
+Orange: Event takes place within the next week
+Yellow: Event takes place within the next 28 days
+Dark: Event takes place within the next 168 days (~ 1/2 year)
+Light beige: Event takes place within the next 365 days (1 year)
+Grey: Event takes place after 365 days
+
+If you are using the 'calendar' tool on UNIX, you can use ~/.calendar as your
+NetCalendar database dir :)
+
+