@@ -1,195 +1,20 @@ - /====================================\ - | Quick Installation with the Wizard | - \====================================/ +Installing BasKet Note Pads +============================ -Quick Instructions -================== +To install BasKet Note Pads, just run the installer executable in a terminal and +follow the on screen instructions. - The installation can easily be performed by launching the -./installer script in a terminal and by following the instructions. -Theire is nothing else to do. +Dependencies +============ -More Information -================ +To build BasKet, the following development packages are required: - In Konqueror, after having un-compressed the .tar.gz file containing -BasKet Note Pads, choose `Open a terminal' while in the un-compressed -folder (the same where you can read this file). -Then, type "./installer" (without the quotes) and press Enter. -You just have to follow the wizard. +Qt v4.4 +kdelibs v4.1 +qimageblitz +kdepimlibs v4.1 - The scrit is there just to simplify your life. -If it does not work or you if want more control (experienced users) on -the configure process, please read the following paragraphs. - - /===================================\ - | Standard UNIX Way of Installation | - \===================================/ - -Basic Installation -================== - - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes a while. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Type `make install' to install the programs and any data files and - documentation. - - 4. You can remove the program binaries and object files from the - source code directory by typing `make clean'. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Alternatively, on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`configure' also accepts some other, not widely useful, options. +If you get an error message about FindGPGMe.cmake not found, you are probably +missing kdepimlibs. +I have not tested with KDE libraries versions 4.0.x and below. INSTALL @@ -13,11 +13,34 @@ function error echo " For example, if libmng cannot be found," echo " please check if libmng AND libmng-devel packages are installed on your system." echo " See the reported errors to know which librarie need to be installed." + echo " If it complains about not being able to find the file FindGpgme.cmake, " + echo " you will need the -devel package of kdepimlibs." + echo " Consult the INSTALL document for a full list of the requirements." echo "" echo $'\a' # Beep to avert user of the error exit 1 } +function prefix_cmd +{ + if test -n "$1"; then + echo '-DCMAKE_INSTALL_PREFIX="$1"' + fi +} + +function do_warning +{ + warn_backup=yes + if test "yes" = "$warn_backup"; then + echo " ===========" + echo " WARNING" + echo " ===========" + echo " You are installing an early development version of BasKet; please back up " + echo " your baskets before using it if you have a previous version of BasKet " + echo " installed." + fi +} + ##echo " (( An error has been encountered ))" ##echo " ((654321 987654321 987654321 98765432 23456789 123456789 123456789 123456))" ##echo" ((654321 987654321 987654321 98765432 23456789 123456789 123456789 123456))" @@ -62,35 +85,7 @@ else prefix=`kde-config --prefix --expandvars` fi -# Uninstall of BasKet: -if [ $WHAT_TO_DO == 3 ]; then - # Search installed basket: - prefix=`kde-config --localprefix --expandvars` # First loacally - if [ -f $prefix/bin/basket ]; then - SYS_WIDE=0 - else - prefix=`kde-config --prefix --expandvars` # And then system wide - if [ -f $prefix/bin/basket ]; then - SYS_WIDE=1 - else - echo "BasKet Note Pads does not seem to be installed." - exit 1 - fi - fi - # TODO: Also definitively remove your baskets? - # At this stage, SYS_WIDE and prefix are set and uninstall can begin: - if [ $SYS_WIDE == 1 ]; then - su - make uninstall || ./configure --prefix=$prefix && make uninstall - logout - else - make uninstall || ./configure --prefix=$prefix && make uninstall - fi - exit 0 -fi - -appVersion=$(cat basket.spec | grep "%define version " | cut -d " " -f 3) -isDevel=$(echo "$appVersion" | grep -i -E "(alpha|beta|pre|rc|svn)") +isDevel=alpha clear echo "" @@ -99,31 +94,20 @@ echo " (( BasKet Note Pads Quick Installer echo " ======================================================================== " echo "" echo "" +do_warning echo "" echo "" echo " If you do not know what they are, you can ignore errors or warnings." echo "" echo " The process can take several minutes." echo " A beep will notify you when it will be done." +echo "" echo " Press ENTER to start." echo "" echo "" read -s -n 1 # read 1 character without echo, ended by ENTER -if [ ! -e configure ]; then - clear - echo "" - echo " ======================================================================== " - echo " (( Preparation from SVN ))" - echo " ======================================================================== " - echo "" - echo "" - - echo "make -f Makefile.cvs" - make -f Makefile.cvs || error -fi - clear echo "" echo " ======================================================================== " @@ -132,12 +116,17 @@ echo " ====================================================================== echo "" echo "" +# No one is going to have a file named "build" here, right? +if test ! -d build ; then + mkdir build +fi + +cd build + if [ "_$isDevel" == "_" ]; then - echo "./configure --prefix=$prefix" - ./configure --prefix=$prefix || error + cmake .. $(prefix_cmd $prefix) || error else - echo "./configure --enable-debug=full --prefix=$prefix" - ./configure --enable-debug=full --prefix=$prefix || error + cmake .. -DCMAKE_BUILD_TYPE=debugfull $(prefix_cmd $prefix) || error fi clear @@ -166,12 +155,12 @@ echo $'\a' # Beep to avert user the configuration/compilation is ended and he mu if [ "_$SYS_WIDE" == "_n" ]; then # First make the bin folder to not copy basket file to bin file if bin/ doesn't exist - mkdir $prefix/bin make install else echo " Please now enter the root password in order to install " echo " BasKet Note Pads on the system." echo "" + echo 'Installing in "'$prefix'"...' sudo make install || exit 1 echo "" echo "" @@ -187,7 +176,7 @@ echo "" echo " Do you want to run BasKet Note Pads now?" echo " If an older version is currently running it will be exited before." echo "" -echo " Notice that you willn't have to exit BasKet : it will be restored each time" +echo " Notice that you won't have to exit BasKet : it will be restored each time" echo " you log in to KDE." echo "" echo "" installer 57887cd3a415f98f3dea81295d715c26600addee Kelvie Wong kelvie@ieee.org http://github.com/kelvie/basket/commit/87c34fd7e07f77d30f50d3b3127f73c4b75b7c2c 87c34fd7e07f77d30f50d3b3127f73c4b75b7c2c 2008-08-03T18:20:35-07:00 2008-08-03T18:10:42-07:00 Updated the INSTALL document and the installer. This just automates the config/build of BasKet, and makes it easier for anyone to just build and run development versions of BasKet. 84bf4638c253d93dc7b71c0de497cdff97bde87f Kelvie Wong kelvie@ieee.org