diff --git a/README.md b/README.md index 639ebbd028..a819e64085 100644 --- a/README.md +++ b/README.md @@ -7,71 +7,62 @@ independent visual components like buttons, windows, checkbox, treeview and many, many more. The LCL is platform independent, so you can write an application once and then compile for various platforms without changing code. -[Free Pascal](https://www.freepascal.org) is a fast Object Pascal compiler (and more), +[Free Pascal](https://www.freepascal.org) is a fast Object Pascal compiler, that runs on more than 20 platforms (Linux, Windows, BSD, OS/2, DOS, PowerPC, and many more). The LCL currently supports: -* Linux/FreeBSD (GTK2, Qt4 and Qt5) +* Linux/FreeBSD (GTK2, Qt4, Qt5 and Qt6) * all flavors of Windows (even WinCE) -* Mac OS X (Cocoa, Carbon, GTK2, Qt4, Qt5) +* macOS (Cocoa, Carbon, GTK2, Qt4, Qt5, Qt6) There is an experimental support for: * GTK3 * Solaris -The LCL still contains code for GTK1, although that is obsolete. +The LCL still contains code for GTK1, although this target is obsolete. --------------------------------------------------------------------------------- -Compilation: -You don't need ```./configure```, just do ```make clean bigide```. -(BSD users: ```gmake clean bigide```). + +### Compilation + +You don't need ```./configure```, just do +```make clean bigide``` (```gmake clean bigide``` in BSD). This will create the Lazarus executable with a lot of packages. Start it and enjoy. If the above gives an error, you can try to build a minimal IDE with -```make clean all```. +```make clean all``` (```gmake clean all``` in BSD). -(BSD users: ```gmake clean all```). - --------------------------------------------------------------------------------- -Installation and Requirements: +### Installation and Requirements See [docs/INSTALL.txt](docs/INSTALL.txt) file. --------------------------------------------------------------------------------- -Usage: +### Usage Start the IDE with: -``` +```shell cd your/lazarus/directory ./lazarus ``` - --------------------------------------------------------------------------------- -Documentation: +### Documentation The official site is www.lazarus-ide.org. Documents about specific topics can be found at https://wiki.freepascal.org/Lazarus_Documentation. -Examples on how to use the LCL can be found in the 'examples' directory. +Examples on how to use the LCL can be found in the [examples](examples) directory. Help, documents and files about Free Pascal are at www.freepascal.org. - --------------------------------------------------------------------------------- -Mailing list: +### Mailing list There is a very active and helpful mailing list for Lazarus, where the developers interact, share ideas, discuss problems, and of course answer questions. You can subscribe at -http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus +http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus. --------------------------------------------------------------------------------- -How to help Lazarus: +### How to help Lazarus If you find bugs, don't hesitate to use issue tracker, or send an email to the list. -Lazarus source code and issue tracker are located at GitLab: -https://gitlab.com/freepascal.org/lazarus/lazarus +Lazarus source code and issue tracker are located at [GitLab](https://gitlab.com/freepascal.org/lazarus/lazarus).