From 480a8a89c2cc5565661ce280f96783de00e7604f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sl=C3=A1vek=20Banko?= Date: Fri, 1 Jul 2022 14:40:46 +0200 Subject: [PATCH] Rework the README and INSTALL files. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Slávek Banko (cherry picked from commit ef5d91dcd2e64e7f72460750ee849112ffebb5e6) --- Building-with-cmake.txt | 51 ------------------------------- INSTALL | 42 +++++++++++++++++++++++++ README.MacOSX => INSTALL.MacOSX | 2 +- README | 54 --------------------------------- README.md | 39 ++++++++++++++++++++++++ 5 files changed, 82 insertions(+), 106 deletions(-) delete mode 100644 Building-with-cmake.txt create mode 100644 INSTALL rename README.MacOSX => INSTALL.MacOSX (99%) delete mode 100644 README create mode 100644 README.md diff --git a/Building-with-cmake.txt b/Building-with-cmake.txt deleted file mode 100644 index 7396d21..0000000 --- a/Building-with-cmake.txt +++ /dev/null @@ -1,51 +0,0 @@ -CMake 2.4.4 (or later) is required to build Kile. - -Building Kile -============= - -1. Get the Kile directory from trunk (there is no need to get the whole office -module anymore). - -2. Create a "kile-build" directory somewhere for an out-of-source build. - -3. Enter the "kile-build" directory and call cmake with: - - cmake -DCMAKE_INSTALL_PREFIX=$HOME/.trinity - - to install Kile later on in the current user's home directory. - -4. In the "kile-build" directory, issue "make" to start the build process. - Issuing "make install" will start the installation process, for which the DESTDIR - option can be used to specify the base directory of the installed files. - - -Building Documentation -====================== - -The documentation will automatically be built provided that the documentation files -are located in the following directories: - - /doc for the standard documentation and - accompanying image files - - /translations - / - /doc for the translated documentation and - images in language - - /messages for the translated message catalogs - in language - -Please note that every docbook must be called "index.docbook" and that only PNG image -files can be used. Furthermore, message catalogs must be called "kile.po". - -When the "doc" and "translations" directories are found, the build targets "docbooks" -and "translations" will be generated for the compiling of the documentation. - - -Special Flags -============= - -The flag "KILE_VERSION" can be set in the CMake cache to specify the installation -directory of basic documentation files (README, AUTHORS, ChangeLog,...), i.e. they -will be installed in "share/doc/kile-${KILE_VERSION}/" instead of "share/doc/kile/". \ No newline at end of file diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..4bac496 --- /dev/null +++ b/INSTALL @@ -0,0 +1,42 @@ +Basic Installation +================== + +kile 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" + + +Requirements for use: +===================== + +Basic: + +- TeTeX 2.0/3.0 or TeXLive (Including "AMS"-Packages and the documentation) +- KDVI + +Advanced: + +- KPDF, KGhostView (Viewing PS and PDF) +- Acroread (Viewing PDF) +- Imagemagick, DVIPNG 1.7 (Bottom bar preview) + +By default there are also tools for the following programs defined: + +- Tar/zip/gzip/bzip2 (Archive) +- DBlatex (Docbook to LaTeX) +- Metapost and Asymptote +- Latex2html (LaTeX to Web) +- Tex4ht (LaTeX to Web) +- Lilypond (Music Typesetting) +- Konqueror/Mozilla/Firefox (Viewing HTML) +- Kbibtex, KBib, JabRef, pybliographer, gbib (View Bibtex files) diff --git a/README.MacOSX b/INSTALL.MacOSX similarity index 99% rename from README.MacOSX rename to INSTALL.MacOSX index ab89a90..2110bd0 100644 --- a/README.MacOSX +++ b/INSTALL.MacOSX @@ -1,7 +1,7 @@ In order to install Kile on MacOS X, you need the following things: - a working X11 installation - a working LaTeX distribution -- the KDE libraries +- the TDE libraries - and Kile itself, of course Once everything is in place, Kile needs X11 to run, so make sure you launch X11 before Kile. diff --git a/README b/README deleted file mode 100644 index 66f8997..0000000 --- a/README +++ /dev/null @@ -1,54 +0,0 @@ -Dear User/Packager, - -this Readme is targeted towards people who want to build Kile from source or plan to create binary packages. -If you have created a package, please drop us a note ( kile-devel@lists.sourceforge.net ) so that we can promote your package. -All specified versions are minimum versions except for KDE and QT. - -1.) Checking dependencies - -- tdelibs 3.2 - 3.5 and according QT development packages -- autoconf 2.53, automake and make (alternatively cmake 2.4.4, see also Building-with-cmake.txt) -- gcc 3.x/4.x - -2.) Building Kile from source - -- Extract the source code with `tar xjf kile-2.0.x.tar.bz2` -- `cd kile-2.0.x` -- ./configure --prefix=path_to_KDE3 (/usr or /opt/trinity generally) --with-qt-dir=path_to_QT3 library (/usr/lib/qt3 generally) - -- If you don't know what the path to KDE3 on your system is, you can use output of `tde-config --prefix`. - -- Or you can choose `--prefix=$HOME/.trinity` to not mess up with your distribution's package management system. -- Type `make` to compile the package. -- Type `make install` to install the programs, data files and documentation. -- Type `kile` and enjoy the power of LaTeX together with the joy of using Kile :) - -3.) Using Kile - -To use Kile you (obviously) need some external programs. -The following list is divided into basic, advanced and additional usage. - -Basic: - -- TeTeX 2.0/3.0 or TeXLive 2005/2007 (Including "AMS"-Packages and the documentation) -- KDVI - -Advanced: - -- KPDF, KGhostView (Viewing PS and PDF) -- Acroread (Viewing PDF) -- Imagemagick, DVIPNG 1.7 (Bottom bar preview) - -By default there are also tools for the following programs defined: - -- Tar/zip/gzip/bzip2 (Archive) -- DBlatex (Docbook to LaTeX) -- Metapost and Asymptote -- Latex2html (LaTeX to Web) -- Tex4ht (LaTeX to Web) -- Lilypond (Music Typesetting) -- Konqueror/Mozilla/Firefox (Viewing HTML) -- Kbibtex, KBib, JabRef, pybliographer, gbib (View Bibtex files) - -If you have any questions or corrections, please don't hesitate to contact us via kile-devel@lists.sourceforge.net. - -The Kile dev team - diff --git a/README.md b/README.md new file mode 100644 index 0000000..0650ef8 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ + +Kile - a user-friendly LaTeX source editor and TeX shell for TDE + + +The source editor is a multi-document editor designed for .tex and .bib +files. Menus, wizards and auto-completion are provided to assist with +tag insertion and code generation. A structural view of the document +assists with navigation within source files. + +The TeX shell integrates the various tools required for TeX processing. +It assists with LaTeX compilation, DVI and postscript document viewing, +generation of bibliographies and indices and other common tasks. + +Kile can support large projects consisting of several smaller files. + +. + +Contributing +-------------- + +If you wish to contribute to kile, you might do so: + +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea + +- TDE Weblate Translation Workspace (TWTW) collaboration tool. + https://mirror.git.trinitydesktop.org/weblate + + +Translations status +--------------------- + +### messages +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kile/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kile/) + +### desktop files +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kile-desktop-files/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kile-desktop-files/)