summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorTomas Bzatek <tbzatek@users.sourceforge.net>2008-06-07 20:34:49 +0200
committerTomas Bzatek <tbzatek@users.sourceforge.net>2008-06-07 20:34:49 +0200
commitecde167da74c86bc047aaf84c5e548cf65a5da98 (patch)
treea015dfda84f28a65811e3aa0d369f8f211ec8c60 /INSTALL
downloadtuxcmd-0.6.36.tar.xz
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL62
1 files changed, 62 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..212ef34
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,62 @@
+INSTALL INSTRUCTIONS
+--------------------
+
+Here are the basic instructions, what you need to do if you want to compile
+Txu Commander.
+
+Quick instructions: Type make help to see list of available targets.
+
+
+There are two compilers supported: FreePascal and Kylix.
+
+FreePascal prerequisities
+-------------------------
+Install the FreePascal package from your distribution or grab the binary
+snapshot from the official web site (http://freepascal.org/). Make sure
+the /etc/fpc.cfg file contains valid configuration (consult the manual first) or
+you may encounter file not found errors.
+
+
+Kylix prerequisities
+--------------------
+First of all you will need to install Borland Kylix. This project is designed
+for use with version 3 Open Edition, but it should compile also with other
+variations (Professional, Enterprise).
+Then you will need the sources of 'gtk2 for pascal' project, they can be
+downloaded from the project site on SourceForge
+(http://gtk2forpascal.sourceforge.net/) or directly from our site
+(http://tuxcmd.sourceforge.net/).
+Extract the downloaded sources (tuxcmd-x.x.x.tar.bz2). Then you need to edit
+the Makefile file. You have to specify real path to Kylix 3 installation
+(it means top-level directory here, where the bin, help, lib
+and source directories are located) - this is the KYLIXPREFIX variable.
+For GTK2FORPASCAL_LIBDIR, specify the path to extracted gtk2 for pascal package
+sources. These are enough informations required to compile the sources.
+The correct make command is 'make kylix'
+
+
+
+At last, you will need basic development utilities, such as GNU make and
+install and gcc & g++ with system development libraries.
+
+Since some of the VFS modules are written in C/C++ and require development
+headers installed in the system, you may experience difficulties with their
+installation. There's no configure script at this moment, only the gnome-vfs
+module requires unusual packages (libgnomevfs2).
+
+So you have configured the sources and you are ready to compilation. Just type
+make or gmake in the directory where is the Makefile file located. It will
+compile the application and all VFS modules. There should not be any problems;
+if some occurs, please check if you have specified correct paths or if you have
+Kylix installed correctly. Also check if you have all required development
+headers installed in your system. To make the application without the modules,
+type 'make tuxcmd' and to make the modules separately run 'make modules'.
+
+To install the application, type 'make install'. You need to have write
+permissions to the target directories, so you probably must be root to do this.
+You can also run 'make clean' to clean the sources and 'make uninstall' to
+safely remove the installed application and all modules.
+
+There are no support for any desktop environment yet, so don't expect any new
+icons in your application menu.
+