diff --git a/Home.md b/Home.md index 939f9bb..4e4e856 100644 --- a/Home.md +++ b/Home.md @@ -1,11 +1,13 @@ -# `loaih` --- LibreOffice AppImage Helper # +# `loaih` -- LibreOffice AppImage Helper # ## Introduction ## -`loaih` --- LibreOffice AppImage Helper --- is a small Python CLI utility to help build AppImages based on specific instructions regarding locale support, help pages and portability. +`loaih` -- LibreOffice AppImage Helper -- is a small Python CLI utility to help build AppImages based on specific instructions regarding locale support, help pages and portability. -**Table of contents** -[Installation](Install.md) -[Usage - versions](Version.md) -[Usage - manual build](Build.md) -[Usage - batch build](Batch.md) \ No newline at end of file +### Table of contents ### + +* [Prerequisites](Prerequisites.md) +* [Installation](Install.md) +* [Usage - versions](Version.md) +* [Usage - manual build](Build.md) +* [Usage - batch build](Batch.md) diff --git a/Install.md b/Install.md new file mode 100644 index 0000000..f484a47 --- /dev/null +++ b/Install.md @@ -0,0 +1,55 @@ +# Installation # + +The page describes how to install `loaih` to help build the AppImages. + +## From sources ## + +You can build `loaih` from the sources in [this same +site](/libreitalia/loaih/). + +1. Clone the repository: + + git clone https://git.libreitalia.org/libreitalia/loaih.git + +2. Enter the directory with the sources: + + cd loaih + +3. Build sources and distribution files: + + python3 setup.py bdist + +4. If you have permissions (e.g. with `sudo`), you can install `loaih` +system-wide: + + sudo python3 setup.py install + +## From Releases ## + +When a new version is released, a binary artifact of the package will be +uploaded to this website in the [Release](/libreitalia/loiah/releases) +section. + +1. Find the latest relaease in the [Release](/libreitalia/loaih/releases) + page and download the relative `.whl` file (e.g. `loaih-1.3.3-py3-none-any.whl`); +2. Ensure you have the `wheel` package installed in your system: + + pip install wheel + +3. Use `pip` to install the wheel you downloaded: + + pip install /path/to/loaih-1.3.3-py3-none-any.whl + +## From PyPI ## + +Finally, the quickest way to have a working version of `loaih` is to install +it directly from [PyPI](https://pypi.org/project/loaih/): + + pip install loaih + + +## Test that `loaih` works ## + +Just execute `loaih` from the command line with any further options: + + loaih diff --git a/Prerequisites.md b/Prerequisites.md new file mode 100644 index 0000000..92540e9 --- /dev/null +++ b/Prerequisites.md @@ -0,0 +1,16 @@ +## Prerequisites ## + +To build any LibreOffice AppImage, you need the following software already +installed on your machine: + +* `cp`: standard POSIX utility to copy files; +* `dpkg`: Considering that we build the AppImage from the Debian packages, +* `find`: it is used mostly to interact with downloaded files; +* `fuse` and the relative kernel modules loaded; + we need `dpkg` to extract the contents; +* `md5sum`: used optionally to create checksums of the generated files; +* `rsync`: if the repository is remote, the application can publish directly + the contents using rsync; +* `sed`: used to manipulate some source files; +* `tar` and `gzip`: used to unpack the general downloads from LibreOffice + official websites.