diff options
author | gregory guy <[email protected]> | 2020-08-08 17:39:17 +0200 |
---|---|---|
committer | gregory guy <[email protected]> | 2020-08-08 17:39:17 +0200 |
commit | fbadfa5f41dca9e13ae65198f5073dd85633d7a8 (patch) | |
tree | 8e1e099f8468b1b271efd268041b6df7068839af | |
parent | 9b5b8e9c826867e7fbcae9a17babdc91af269b93 (diff) | |
download | mathemagics-fbadfa5f41dca9e13ae65198f5073dd85633d7a8.tar.gz mathemagics-fbadfa5f41dca9e13ae65198f5073dd85633d7a8.zip |
Fix help page install location.
Rework of the help page, README and INSTALL files.
Signed-off-by: gregory guy <[email protected]>
-rw-r--r-- | INSTALL | 186 | ||||
-rw-r--r-- | README | 66 | ||||
-rw-r--r-- | doc/en/index.docbook (renamed from doc/mathemagics/index.docbook) | 22 |
3 files changed, 40 insertions, 234 deletions
@@ -1,176 +1,16 @@ 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. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -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 - -Or 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/kde/bin', `/usr/local/kde/lib', etc. You can specify an -installation prefix other than `/usr/local/kde' 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. - +mathemagics relies on cmake to build. + +Here are suggested default options: + + -DCMAKE_INSTALL_PREFIX="/opt/trinity" \ + -DCONFIG_INSTALL_DIR="/etc/trinity" \ + -DSYSCONF_INSTALL_DIR="/etc/trinity" \ + -DXDG_MENU_INSTALL_DIR="/etc/xdg/menus" \ + -DCMAKE_BUILD_TYPE=RelWithDebInfo \ + -DCMAKE_VERBOSE_MAKEFILE="ON" \ + -DCMAKE_SKIP_RPATH="OFF" \ + -DBUILD_ALL="ON" \ + -DWITH_ALL_OPTIONS="ON" @@ -1,63 +1,19 @@ -What is kdenonbeta? -------------------- -This package contains software modules that are considered by their -authors preceding beta stage, hence "nonbeta" (which means "alpha at -best"), and are not normally released. The programs and libraries that -are developed here are sometimes moved to official release packages -(like tdegraphics) as the program or library matures to a sufficiently -stable state. Beware that some of the programs are not maintained or -may be suffering bit rot. +mathemagics - a RPN scientific calculator for TDE. -This place is also touted as a place for free collaborative development of -KDE related software. +Mathemagics makes use of the Reverse Polish Notation or RPN. +Mathemagics can store and use user-defined functions and variables, It +comes with large number of built-in functions as well. -Package contents ----------------- -Read the INDEX file to find out about the description and status of each -module. +CONTRIBUTING +============== +If you wish to contribute to Mathemagics, you might do so: -Building kdenonbeta -------------------- +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea -kdenonbeta is fairly large, at around 170 Mbytes of source code. That -much code in active development means that it is unlikely all of -kdenonbeta will compile and work at once. You probably don't want to -build all of kdenonbeta - pick the bits you are interested in and just -build that. - -There are a number of ways to manage the build process: - -1. Only checkout what you need. If you use a sequence like - cvs co -l kdenonbeta - cd kdenonbeta - cvs co admin (or ln -s ../kde-common/admin ./admin) - cvs up <subdir> -you will only get the active directories. This is a good idea in terms -of build time, and also on load on the CVS servers. - -2. Create a file called inst-apps in the toplevel directory to compile -modules you want. The file should contain each module name on a -separate line, like: - konversation - kttsd -Then do your make -f Makefile.cvs && ./configure etc. - -3. Exclude the modules you don't want, by adding them to the -DO_NOT_COMPILE variable. For example, if you want to exclude -dcopbindings, then edit dcopbindings/configure.in.in to include the -line: - DO_NOT_COMPILE="$DO_NOT_COMPILE dcopbindings" - - -Using kdenonbeta ---------------- - -The package uses the standard autoconf/automake based KDE build system. To -add a new module to the build, create a subdirectory with your code and then -say "make -f Makefile.cvs". - -Don't forget to add your new subdirectory to the INDEX file. +- TDE Weblate Translation Workspace (TWTW) collaboration tool. + https://mirror.git.trinitydesktop.org/weblate diff --git a/doc/mathemagics/index.docbook b/doc/en/index.docbook index ff1092c..ed37e23 100644 --- a/doc/mathemagics/index.docbook +++ b/doc/en/index.docbook @@ -30,7 +30,7 @@ <date>2002-05-25</date> <releaseinfo>1.0</releaseinfo> -<abstract><para>&mathemagics; is a scientific RPN calculator for &kde;.</para></abstract> +<abstract><para>&mathemagics; is a scientific RPN calculator for &tde;.</para></abstract> <keywordset> <keyword>KDE</keyword> @@ -263,17 +263,27 @@ XOR (exclusive OR) operation.</term> <appendix id="installation"> <title>Installation</title> -<para>&mathemagics; is part of the &package; package within the &kde; project. For more details about &kde; visit <ulink url="http://www.kde.org">http://www.kde.org</ulink>.</para> +<para>&mathemagics; is part of the &tde; project. For more details about &tde; visit <ulink url="http://trinitydesktop.org">http://trinitydesktop.org</ulink>.</para> <para>&mathemagics;'s website is <ulink -url="http://katzbrown.com/mathemagics/"> -http://katzbrown.com/mathemagics/</ulink></para> +url="https://mirror.git.trinitydesktop.org/gitea/TDE/mathemagics"> +https://mirror.git.trinitydesktop.org/gitea/TDE/mathemagics</ulink></para> <sect1 id="compilation-and-installation"> <title>Compilation and Installation</title> -&install.intro.documentation; -&install.compile.documentation; +<para> +In order to compile and install &mathemagics; on your system, type the following in the base directory; distribution: +<screen width="40"> +<prompt>%</prompt> <userinput>mkdir -p build</userinput> +<prompt>%</prompt> <userinput>cd build</userinput> +<prompt>%</prompt> <userinput>cmake ../</userinput> +<prompt>%</prompt> <userinput>make</userinput> +<prompt>%</prompt> <userinput>make install</userinput> +</screen> +</para> + +<para>Since &mathemagics; uses cmake you should have not trouble compiling it. Default options for cmake build are available in the INSTALL file.</para> </sect1> </appendix> |