|
Developers' side bar
Selected categories
Edit
Shared groups
Links
|
<< | Page list | >>
Notes about the files in the trunk of lyx-devel/ and their purpose.
1.1 Standard Autotools files
| COPYING | GNU general public license |
| INSTALL | Information about compiling and installing LyX in the common case. Known problems are also listed at the end of this file. |
| NEWS | A collection of major points from the previous announcements, presented in reverse chronological order. |
| README | To be read first by someone using the source. It should give pointers about where to go next. A short description, prerequisites and further reading is provided. |
1.2 Specific ReadMe files
| README.Cygwin | LyX has been build on CygWin using traditional autotools (autoconf, automake, make etc), and a scons build system. Prerequisites and directions for building in CygWin are located in this file. | t |
| README.Win32 | This is mostly a stub that points the reader towards INSTALL.Win32, saying that if you want to participate in the development of LyX and need to compile LyX for Windows yourself, please follow the instructions in INSTALL.Win32. |
| README.localization | This file is mainly intended for those who have no or little experience using .po files, but want to contribute by translating the LyX interface (i.e. menu and dialog items, console messages) into their native language. |
1.3 Specific Install files
| INSTALL.MacOSX | LyX/Mac is built from the LyX source, the GPL-licensed Trolltech Qt/Mac library, and a custom application bundle. This and other specifics are listed here. |
| INSTALL.Win32 | Compiling LyX for Win32 and creating Windows installer. One will find out that it's recommended to compile LyX using Microsoft Visual C 2010 and CMake. Pre-compiled packages with dependencies are provided for this environment. |
| INSTALL.autoconf | These are generic instructions for using autoconf tools in a Unix or Unix like environment. Extended informations about generic configure scripts are included. |
| INSTALL.scons | deprecated |
| INSTALL.cmake | CMake is a build system file generator. On all systems it could generate files for several build systems, for instance Makefiles for make, project files for Visual Studio, Xcode, Eclipse. Both generic and specific informations are provided. |
1.4 Scripts and script input
| Makefile.am | Automake works by reading a Makefile.am and generating a Makefile.in. Certain variables and rules defined in the Makefile.am instruct Automake to generate more specialized code; for instance, a bin_PROGRAMS variable definition will cause rules for compiling and linking programs to be generated. http://www.gnu.org/s/hello/manual/automake/General-Operation.html |
| autogen.sh | Script that takes care of autotools related tasks that are required beforerunning configure. The workflow is: ./autogen.sh -> ./configure -> make -> make install |
| configure.ac | This is an input file for autoconf. It contains tests that check for conditions that are likely to differ on different platforms. The tests are made by actually invoke autoconf macros. configure.ac is processed by m4 which produces ./configure. Basically, configure.ac is copied, but macros found within configure.ac are expanded. http://www.adp-gmbh.ch/misc/tools/configure/configure_in.html |
| lyx.1in | The man page for LyX. This is only a brief description and the user is invited to make use of the help system. |
1.5 Various
| ABOUT-NLS | The distributed package does use GNU `gettext' internally. This file provides information about installing and using it in the context of this package. |
| ANNOUNCE | The file ANNOUNCE is the source/copy of the announcement that's sent out when a new version is released. |
| RELEASE-NOTES | This file lists Important things to know about present release: interface changes that might affect users in present release, some known problems in present release and some things you have to take into account when upgrading from earlier versions to present release. It also includes known bugs that have not been fixed. |
| UPGRADING | Procedures to follow when upgrading from a previous version to present release. |
| intl | GNU gettext library is an important step for the GNU Translation Project, as it is an asset on which we may build many other steps. This package offers to programmers, translators, and even users, a well integrated set of tools and documentation. Specifically, the GNU `gettext' utilities are a set of tools that provides a framework to help other GNU packages produce multi-lingual messages. https://www.gnu.org/s/gettext/ |
| lib | A folder for adjacent content like: scripts, examples, documentation, layouts,... |
| m4 | GNU m4 is an implementation of the traditional Unix macro processor. A number of such scripts are stored here. |
| po | Files supporting the translation of the LyX components in various languages. |
| sourcedoc | Files related to creating source code documentation using Doxygen |
| src | The source code. |
Category: Development, LyXGit
|
