packages icon
XSTEP 3.5

Copyright (C) 1996-2000 by Marcelo Samsoniuk and colaborators

INTRODUCTION

	Welcome to 5th revision of XSTEP3, a faster and small library
	designed for easy creation of X applications, with the look and feel
	of NeXTSTEP(tm) graphic interface. You're welcome to redistribute,
	modify and use this software for any purpose, subject to conditions
	listed in the COPYING/LICENCE files.

	This README file is only a fast and generic introduction to XSTEP,
	for a more advanced and complete reference, see the 'doc' directory,
	many html documentations are now part of xstep package.

	ATENTION: the XSTEP 3.5 package contain a mixed licence, the XSTEP
	library can be used with the more flexible LGPL licence (see LICENCE
	in the library directory), all other softwares and documentations
	are subject to GPL licente (see the COPYING in many documentation
	and source directories). Well, all proprietary images and codes are
	removed from this package. 

INSTALLING XSTEP

	To compile the XSTEP library, just type:

		make

	Your system must be a unix-like system and must have the X headers
	and libraries (X11R6 is recommended), any 32 bit C compiler w/
	support for shared libraries (GCC is recomended) and any 'make' (GNU
	and BSD makes are recommended).

	If you don't receive any error message, a shared library will be
	generated in the directory 'library'. You can install this library (and
	XSTEP headers) typing:

		make install

	You can uninstall XSTEP any time with:

		make uninstall

	This library is binary compatible with applications compiled with
	XSTEP versions 3.1 and above. Many applications compiled with XSTEP
	version 3.1 will work, but a recompilation is very recomended.

	Applications created before XSTEP version 3.1 don't use the shared
	library libxstep.so, but you can recompile these applications with
	the last version of XSTEP, just edit the file and replace the
	include of <xstep.h> by <xstep-port.h>, this is a header with macros
	to convert the calls of old XSTEP widgets to new versions.

	Many new demonstration applications and examples of ported
	applications from old versions (XSTEP 2.0 and XSTEP 3.0) are
	available in 'applications' directory, examples of all widgets are
	available in the 'examples' directory. To compile and run these
	applications or examples, enter in 'applications' or 'examples'
	directory and type:

		make; make show


CREATING APPLICATIONS

	This section have only a fast introduction to XSTEP programming, for
	more advanced and complete details please check the documentation in
	the 'doc' directory.

	To create XSTEP applications you must compile and install the XSTEP
	library, then you can create a C file, like 'xhelloworld.c':

		#include <xstep.h>
		#include "mozilla.xpm"

		void xmain(int i,char **p) {
                                           
			struct xtree *t;
                      
		        window_create(0,0,400,180,"My First Application!");

		        defaultfont=helvetica24b;
		        label_create(0,0,0,0,"Hello World!",gray,up);
		        defaultfont=helvetica12m;

		        t=button_create(-8,-8,72,72,"Quit",window_close);
			mkpixmap(mozilla,t);
		}

	Warning! XSTEP applications start with xmain(), not main()

	The compilation if  X applications by hand is a hard task and is 
	high recommendable to you use a Makefile like this:

		         CC  = gcc
		     CFLAGS  = -Wall -O3 -funroll-all-loops -pipe 
		     CFLAGS += -I/usr/X11R6/include -I/usr/local/include
		     CFLAGS += -L/usr/X11R6/lib -lX11
		     CFLAGS += -L/usr/local/lib -lxstep
		APPLICATIONS  = xhelloworld

		all: $(APPLICATIONS)

		clean:
		        rm $(APPLICATIONS)

	with this Makefile, then just type 'make' to compile :)

	If you write others small applications, just add these to
	APPLICATIONS variable:

		APPLICATIONS  = xhelloworld xpagemaker xphotoshop
	
	and retype 'make' :)

FOR MORE INFORMATIONS

	Many versions of XSTEP and related applications can be found in: 

		http://xstep.dhs.org

	The last stable version is usually available in:

		ftp://sunsite.unc.edu/pub/Linux/libs/X/clibs

	Sugestions, comments and problem reports related to XSTEP are
	welcome and can be send to marcelo@xstep.dhs.org.

	Look the 'doc' directory for more complete information about the
	XSTEP programming and good hacking :D