Merge pull request #118 from rchastain2/edit_readme

Edit readme

Author: fredvs

readme.md renamed to README.md

@@ -11,7 +11,8 @@ On Windows, it deals with the low level Windows GDI interface.
 MSEgui is like a GTK2/GTK3/Qt5 widgetset with same look-and-feel on each OS (Linux, FreeBSD, OpenBSD, NetBSD, MacOS and Windows).
 And because it is developed in Pascal, you have full control on the widgetset.
 
-# Features
+## Features
+
 - Compiles with FPC 2.6.4, 3.0.0, 3.0.2, 3.2.0, 3.2.2. and 3.3.1.
 - Compiles with FPC-LLVM 3.3.1.
 - For FreeBSD-x86_64, FreeBSD-i386, FreeBSD-aarch64,
@@ -22,17 +23,18 @@ And because it is developed in Pascal, you have full control on the widgetset.
   Darwin-MacOs-x86_64, Darwin-MacOs-aarch64,
   Windows-i386, Windows-x86_64.
 - Links to xlib and gdi32, no external widget library needed.
-- Internal character encoding is utf-16.
-- Uses anti aliased fonts on Linux (Xft).
-- All screen drawing is double buffered.
+- Internal character encoding is UTF-16.
+- Uses anti-aliased fonts on Linux (Xft).
+- All screen drawing is double-buffered.
 - Has docking forms and MDI.
 - Has embedded forms (similar to TFrame).
 - Has sophisticated database access components and data edit widgets.
 - Internationalization functionality with resource modules.
 - Report generator.
 - BGRABitmap graphic library compatible.
 
-# IDE
+## IDE
+
 - Integrated debugging.
 - Source code highlighting.
 - Source code navigation with support for include files.
@@ -44,11 +46,14 @@ And because it is developed in Pascal, you have full control on the widgetset.
 - Visual form inheritance.
 - Integrated report designer.
 
-### About MSEide+MSEgui
+## About MSEide+MSEgui
+
 MSEide+MSEgui is exclusively designed for use with Free Pascal (FPC). It is not compatible with Delphi or Lazarus.
 
-### Demos and Examples
+## Demos and Examples
+
 To get the most out of MSEide+MSEgui, we highly recommend exploring our extensive collection of demos located in this repository. These demos are tailored to showcase various aspects of MSEgui's capabilities, usage patterns, and how to address common programming tasks with FPC. 
+
 - **Demos in package**: in the mseide-msegui/apps/ folder.
 - **Demos from mseuniverse**: https://github.com/mse-org/mseuniverse
 
@@ -58,15 +63,17 @@ Before you ask questions, contribute, or report issues, please take a moment to
 
 [![Examples](https://img.shields.io/badge/Examples-Important-orange)](https://github.com/mse-org/mseuniverse)
 
-# License
+## License
+
 IDE and tools are under GPL, library under modified LGPL like FPC-RTL.
 Package maintainers may delete the files "apps/ide/COPYING.GPL",
 "lib/common/COPYING.LGPL" and "lib/common/COPYING.MSE".
 
-# Installation
+## Installation
+
 1. Download and install FPC, you can get it from 
    http://www.freepascal.org/download.var
-2. Download mseide-msegui source from 
+2. Download MSEide+MSEgui source from 
    https://github.com/mse-org/mseide-msegui/archive/master.zip
 3. Extract them to a directory of your choice. For example "/home/myself/mseide-msegui".
 4. Download and unzip mseide binary according your OS from here:
@@ -87,30 +94,61 @@ libX11-devel or libX11-dev package or make a symbolic link
 see
 https://bugs.freepascal.org/view.php?id=32367
 
-# If you want to compile the IDE
+## Other installation methods
+
+### Bash installer
+
+There is a Bash installer for Linux that you can find [here](https://github.com/rchastain2/scripts/tree/main/install-mseide).
+
+The script clones the git repository, build the IDE, and creates a desktop shortcut.
+
+The **-b** option allowes to choose installation root directory.
+
+```bash
+sh install-mseide.sh -d $HOME
+```
+
+## If you want to compile the IDE
 
 1. In 'Project'-'Open' select 'sourcedirectory/apps/ide/mseide.prj'.
 2. 'Target'-'Continue'.
 
-## Compiling MSEide from commandline:
+### Compiling MSEide from commandline
+
 On Unix:
+
+```
 fpc -Fulib/common/* -Fulib/common/kernel/linux apps/ide/mseide.pas
+```
 
 On Windows:
+
+```
 fpc -Fulib\common\* -Fulib\common\kernel\windows apps\ide\mseide.pas
+```
+
+### If FPC crashes while compiling try on Linux and FreeBSD
 
-## If FPC crashes while compiling try on Linux and FreeBSD
+```
 fpc -B -Fulib/common/* -Fulib/common/kernel/linux apps/ide/mseide.pas
+```
+
 On Windows:
+
+```
 fpc -B -Fulib\common\* -Fulib\common\kernel\windows apps\ide\mseide.pas
+```
+
+## Creating a new GUI project
 
-# Creating a new GUI project
 'Project'-'New'-'From Template', select "default.prj"
 
-# Creating a new console project
+## Creating a new console project
+
 'Project'-'New'-'From Template', select "console.prj"
 
-# MSEgui command line parameters
+## MSEide command-line parameters
+
 ```
 --FONTALIAS=<alias>,<fontname>[,<fontheight>[,<fontwidth>[,<options>[,<xscale>]
                               [,<ancestor>]]]]
@@ -150,10 +188,7 @@ fpc -B -Fulib\common\* -Fulib\common\kernel\windows apps\ide\mseide.pas
 
 --NOSTATICGRAVITY
  Simulates staticgravity for buggy window managers.
-```
 
-# MSEide command line parameters
-```
 -np
  Do not load a project.
 
@@ -175,36 +210,44 @@ fpc -B -Fulib\common\* -Fulib\common\kernel\windows apps\ide\mseide.pas
  terminate MSEide.
 ```
 
-# MSEide environment variables
+## MSEide environment variables
+
 Macros in 'Settings'-'Configure MSEide' can be overridden by environment
 variables. They will be overriden by --macrodef and 'Project'-'Options'-'Macros'.
+
 Possible names:
 FPCDIR, FPCLIBDIR, MSEDIR, MSELIBDIR, SYNTAXDEFDIR, TEMPLATEDIR,
 COMPSTOREDIR, COMPILER, DEBUGGER, EXEEXT, TARGET, TARGETOSDIR.
 
-# MSEide project macros
+## MSEide project macros
+
 Predefined project macros:
 PROJECTNAME, PROJECTDIR, MAINFILE, TARGETFILE,
 TARGETENV (in format for "env" unix command), TARGETPARAMS,
 they can be overridden by 'Project'-'Options'-'Macros'.
 
-# MSEide macro functions
+## MSEide macro functions
+
 ```
 ${MAC_IFDEF(macroname)} returns the macro value if defined.
 ${MAC_IFDEF(macroname,notdefinedvalue)} returns the macro value if defined,
  notdefinedvalue otherwise.
 ${MAC_IFDEF(macroname,notdefinedvalue,definedvalue)}
  returns definedvalue if macroname is defined, notdefinedvalue otherwise.
 ```
-# MSEide environment macros
+
+## MSEide environment macros
+
 ```
 ${ENV_VAR(variablename)} returns the variable value if defined.
 ${ENV_VAR(variablename,notdefinedvalue)} returns the variable value if defined,
  notdefinedvalue otherwise.
 ${ENV_VAR(variablename,notdefinedvalue,definedvalue)}
  returns definedvalue if variablename is defined, notdefinedvalue otherwise.
 ```
-# MSEide string macros
+
+## MSEide string macros
+
 ```
 Macro format is ${STR_*(text)}.
 STR_TRIM
@@ -219,7 +262,9 @@ STR_COALESCE
  ${STR_COALESCE(text[,text...])} or
  ${STR_COALESCE("text"[,"text"...])}
 ```
-# MSEide file macros
+
+## MSEide file macros
+
 ```
 Macro format is ${FILE_*(fileparameter)} or ${FILE_*("fileparameter")}.
 FILE_MSE       convert to MSE format.
@@ -233,21 +278,29 @@ FILE_EXT       file name extension.
 FILE_NONAME    directory part only.
 FILE_NOEXT     no file name extension.
 ```
-# MSEide exec macros
+
+## MSEide exec macros
+
 ```
 ${EXEC_OUT(commandline[,timeoutms])}
  Executes commandline, returns the process output. Timeout in
  milli seconds, default = 1000, -1 = infinite.
 ```
-# MSEide macros in 'Project'-'Options'-'Debugger'-'xterm Command'
+
+## MSEide macros in 'Project'-'Options'-'Debugger'-'xterm Command'
+
 ```
 ${PTS} expands to tty pts path.
 ${PTSN} expands to tty pts number.
 ${PTSH} expands to tty pts handle.
 Entering an empty string restores the default.
 ```
-# MSEide external tools parameters macros
+
+## MSEide external tools parameters macros
+
 Predefined macros in 'Project'-'Options'-'Tools'-'Parameters':
+
+```
 CURSOURCEFILE current source file.
 CURMODULEFILE current *.mfm file.
 CURSSELECTION selected text in source editor.
@@ -257,17 +310,23 @@ CURSDEFINITION} definition of the current token at cursor
  (Parse source before call) to be current.
 CURCOMPONENTCLASS current selected component class in form editor.
 CURPROPERTY current selected property in object inspector.
+```
+
+## Known issues
+
+### Antialiased text with MSEgui 32-bit on 64-bit Linux
 
-# Antialiased text with MSEgui 32 bit on 64 bit Linux
 MSEgui uses Xft for antialiased fonts on Linux. Please install lib32-libxft
 package if necessary.
 
-# Popup widgets behind the forms
+### Popup widgets behind the forms
+
 If the popup widgets are showed behind the forms, try to start the
 MSEgui program with the option '--TOPLEVELRAISE'. Do *not* use this option
 if is not necessary (KDE, Gnome... work well without).
 
-# Display problems with Linux radeon and other EXA drivers
+### Display problems with Linux radeon and other EXA drivers
+
 If the display is distorted or slow add
 Option "EXAPixmaps" "off"
 to
@@ -277,28 +336,32 @@ https://bugs.freedesktop.org/show_bug.cgi?id=69543
 https://bugs.freedesktop.org/show_bug.cgi?id=84253
 or use the proprietary video driver for your video chip.
 
-# Flashing taskbar widgets in IceWM
+### Flashing taskbar widgets in IceWM
+
 Newer revisions of IceWM let the taskbar icons of MSEgui applications flash.
 Start the MSEgui application with the option '--TOPLEVELRAISE'.
 
-# Invalid inputmanager for Ubuntu
+### Invalid inputmanager for Ubuntu
+
 The utf-8 setup in Ubuntu seems to be incomplete. If you get the exception
-"egui : Invalid inputmanager tinternalapplication ." at program start, try to
+"egui : Invalid inputmanager tinternalapplication" at program start, try to
 replace your language locale in /usr/share/X11/locale/locale.dir
 by en_US as a workaround. Example for ru_RU.UTF-8:
 replace
 ru_RU.UTF-8/XLC_LOCALE ru_RU.UTF-8
 by
 en_US.UTF-8/XLC_LOCALE ru_RU.UTF-8
 
-# Wrong window positions for Ubuntu 14.04
+### Wrong window positions for Ubuntu 14.04
+
 Window positions in Unity are wrong because the Ubuntu windowmanager
 does not support static_gravity:
 http://askubuntu.com/questions/451903/wingravity-static-gravity-not-suppo
 https://bugs.launchpad.net/ubuntu/+bug/1312044
 http://askubuntu.com/questions/457456/wingravity-static-gravity-not-supported-in-14-04
 
-# How to add custom components to MSEide
+## How to add custom components to MSEide
+
 There is a project 'apps/myide/mymseide.prj' as a demo.
 Start MSEide, open project 'apps/myide/mymseide.prj', 'Project'-'Build',
 'Target'-'Continue',
@@ -320,19 +383,22 @@ apps/ide/COPYING.IDE
 
 If you want to add custom icons to your components:
 
-- Convert 24*24 pixel BMP or PNG files with tools/bmp2pas to
+- Convert 24x24 pixel BMP or PNG files with tools/bmp2pas to
   an icon unit ('*_bmp.pas').
 - Add the name of the icon unit to 'uses' in your register unit.
 
-# How to run i18ndemo
+## How to run i18ndemo
+
 ```
 - Start MSEide.
 - 'Project'-'Open'-'yourdirectory/msegui/apps/i18ndemo/i18ndemo.prj'.
 - 'Project'-'Make' to create the rsj files.
 - 'Project'-'Open'-'yourdirectory/msegui/tools/i18n/msei18n.prj'.
 - 'Target'-'Continue'.
 ```
+
 In MSEi18n:
+
 ```
  - Adjust 'Settings'-'Configure MSEi18n'-'${MSEDIR}' and ${COMPILER}.
  - 'Open'-'yourdirectory/msegui/apps/i18ndemo/i18ndemo.trp'
@@ -343,8 +409,10 @@ In MSEi18n:
  - 'Target'-'Continue'.
 ```
 
-# SQLite
+## SQLite
+
 tsqlite3connection field type mapping:
+
 ```
       Type name        SQLite storage class  Field type    Data type
 +--------------------+---------------------+-------------+-------------+
@@ -369,7 +437,8 @@ tsqlite3connection field type mapping:
 +--------------------+---------------------+-------------+-------------+
 ```
 
-# ZeosLib
+## ZeosLib
+
 Since msegui commit fbbaa979b, ZeosLib components are included in mseide by default.
 Also last stable source are included in /mseide-msegui/lib/common/mzeoslib/.
 
@@ -380,7 +449,8 @@ If you want to recompile the IDE with new ZeosLib source, add parameter '-dmse_w
 There is a predefined IDE project apps/ide/mseide_zeos.prj, update 'Project'-
 'Options'-'Macros' according to your installation.
 
-# Crosscompiling and remote debugging i386/x84_64-linux -> arm-linux
+## Crosscompiling and remote debugging i386/x84_64-linux -> arm-linux
+
 For Raspberry Pi:
 - Establish a ssh login without password (public key authentication).