lite-xl/scripts/README.md

# Scripts

Various scripts and configurations used to configure, build, and package Lite XL.

### Build

- **build.sh**
- **build-packages.sh**: In root directory, as all in one script; relies to the
  ones in this directory.

### Package

- **appdmg.sh**:    Create a macOS DMG image using [dmgbuild][1].
- **appimage.sh**:  [AppImage][2] builder.
- **innosetup.sh**: Creates a 32/64 bit [InnoSetup][3] installer package.
- **package.sh**:   Creates all binary / DMG image / installer / source packages.

### Utility

- **common.sh**:                 Common functions used by other scripts.
- **install-dependencies.sh**:   Installs required applications to build, package
                                 and run Lite XL, mainly useful for CI and documentation purpose.
                                 Preferably not to be used in user systems.
- **fontello-config.json**:      Used by the icons generator.
- **generate_header.sh**:        Generates a header file for native plugin API
- **keymap-generator**:          Generates a JSON file containing the keymap
- **generate-release-notes.sh**: Generates a release note for Lite XL releases.

[1]: https://github.com/dmgbuild/dmgbuild
[2]: https://docs.appimage.org/
[3]: https://jrsoftware.org/isinfo.php
Adapt all scripts to work together with build-packages.sh 2021-08-29 10:15:55 +02:00			`# Scripts`

			`Various scripts and configurations used to configure, build, and package Lite XL.`

			`### Build`

			`- build.sh`
			`- build-packages.sh: In root directory, as all in one script; relies to the`
			`ones in this directory.`

			`### Package`

refactor(build): use dmgbuild to create dmgs (#1664) * refactor(appdmg): make dmgs with dmgbuild * fix(appdmg.sh): typo * refactor(appdmg.sh): don't generate config on the fly * fix(dmgbuild): icon file * fix(gitignore): dmgbuild settings * chore(resources): update readme with new files * chore(resources/macos): add missing newline 2023-11-10 02:44:58 +01:00			`- appdmg.sh: Create a macOS DMG image using [dmgbuild][1].`
Adapt all scripts to work together with build-packages.sh 2021-08-29 10:15:55 +02:00			`- appimage.sh: [AppImage][2] builder.`
			`- innosetup.sh: Creates a 32/64 bit [InnoSetup][3] installer package.`
			`- package.sh: Creates all binary / DMG image / installer / source packages.`

			`### Utility`

Generate release notes (#1774) * ci: generate better release notes * scripts: rename generate-release-note.sh * ci/release: check out all the history * ci/release: accept version from input 2024-05-18 01:12:04 +02:00			`- common.sh: Common functions used by other scripts.`
			`- install-dependencies.sh: Installs required applications to build, package`
			`and run Lite XL, mainly useful for CI and documentation purpose.`
			`Preferably not to be used in user systems.`
			`- fontello-config.json: Used by the icons generator.`
			`- generate_header.sh: Generates a header file for native plugin API`
			`- keymap-generator: Generates a JSON file containing the keymap`
			`- generate-release-notes.sh: Generates a release note for Lite XL releases.`
Adapt all scripts to work together with build-packages.sh 2021-08-29 10:15:55 +02:00
refactor(build): use dmgbuild to create dmgs (#1664) * refactor(appdmg): make dmgs with dmgbuild * fix(appdmg.sh): typo * refactor(appdmg.sh): don't generate config on the fly * fix(dmgbuild): icon file * fix(gitignore): dmgbuild settings * chore(resources): update readme with new files * chore(resources/macos): add missing newline 2023-11-10 02:44:58 +01:00			`[1]: https://github.com/dmgbuild/dmgbuild`
Adapt all scripts to work together with build-packages.sh 2021-08-29 10:15:55 +02:00			`[2]: https://docs.appimage.org/`
			`[3]: https://jrsoftware.org/isinfo.php`