summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2009-02-07 22:20:21 +0000
committerPaul Buetow <paul@buetow.org>2009-02-07 22:20:21 +0000
commitdc1e42740c40211c67918398990a2bb3b373356f (patch)
treed45d1a53837b77f13bd15c7e550cccad31cd4d5a
parentfd086f5895ba56fb8b6282929c8ed1357e0b5069 (diff)
english documentation
-rw-r--r--README.de.txt (renamed from LIESMICH.txt)9
-rw-r--r--README.en.txt55
-rw-r--r--config.txt2
3 files changed, 62 insertions, 4 deletions
diff --git a/LIESMICH.txt b/README.de.txt
index 41683c5..9b006e5 100644
--- a/LIESMICH.txt
+++ b/README.de.txt
@@ -1,4 +1,6 @@
-Quick howto fuer den NetCalendar
+Copyright: (c) 2006, 2009 Dipl.-Inform. (FH) Paul C. Buetow
+WWW: http://netcalendar.buetow.org
+Mail: netcalendar@dev.buetow.org
Starten des NetCalendars im stand alone betrieb:
@@ -36,13 +38,14 @@ Gruen in der "Date" Spalte: Einmaliges Event
Rot: Event findet innerhlab der nächste 24h statt.
Orange: Event findet innerhalb der nächsten Woche statt.
Gelb: Event findet innerhalb der nächsten 28 Tage statt.
-Dunkelbesch: Event findet innerhalb der nächsten 168 Tage (~ 1/2 Jahr) statt.
+Dunkelbeige: Event findet innerhalb der nächsten 168 Tage (~ 1/2 Jahr) statt.
Hellbesch: Event findet innerhalb der nächsten 365 Tage statt.
Grau: Event findet nicht in den nächsten 365 Tagen statt.
Funktionen die in der Zukunft evtl. eingebaut werden sollen stehen in der "todo.txt" Datei.
-
+Falls das 'calendar' UNIX-Tool verwendet wird, dann kann ~/.calendar auch als
+NetCalendar Datenbankverzeichnis konfiguriert werden :)
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 :)
+
+
diff --git a/config.txt b/config.txt
index 9ca7649..dbc3e3d 100644
--- a/config.txt
+++ b/config.txt
@@ -4,7 +4,7 @@ logfile=netcalendar.log;
passphrase=dsfiu6786sdfsdhf;
regexp_case_insensitive=true;
server_address=localhost;
-server_database_dir=/usr/home/buetow/.calendar;
+server_database_dir=calendardb;
server_port=4321;
server_run=true;
server_startup_command=none;