README.md 1.24 KB
Newer Older
Jonathan Riddell's avatar
Jonathan Riddell committed
1 2 3 4 5 6 7
# Intro

This uses build.kde.org and its ci-tooling to download builds and extract the
appstream data from them.

You will needs some space in /tmp and lots of space (20GB) in /srv.

Jonathan Riddell's avatar
Jonathan Riddell committed
8 9 10 11 12 13
It uses repo-metadata to get a list of projects
- https://cgit.kde.org/sysadmin/repo-metadata.git/

which is available through the API at
- https://projects.kde.org/api/

Harald Sitter's avatar
import  
Harald Sitter committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# Tools

## appstream.rb

Collects **desktop application** appdata from CI install dirs and as a fallback
from Git.

Requires valid screenshots and icons to be available!
Limited functionality with Git fallback. All software should be CI'd really.

Twiddles the following dirs:

- `../appdata/` appdata cache. contains json blobs converted from appdata
- `../icons/` icons cache. contains icons named from their appid (org.kde.foo.svg)
- `../thumbnails` thumbnails cache. scaled to 540 width. subdir per appid

Jonathan Riddell's avatar
Jonathan Riddell committed
30
## appstream_mkindex.rb
Harald Sitter's avatar
import  
Harald Sitter committed
31 32 33 34 35

Iters `../appdata/` and generates an `../appdata/index.json` mapping category
names to appids. The icons for the categories are generated by appstream.rb
and in `../icons/categories/` as downcased version of the name.

Jonathan Riddell's avatar
Jonathan Riddell committed
36
## old_apps_compat.rb
Harald Sitter's avatar
import  
Harald Sitter committed
37 38 39

Iters `../apps/` and generates compatibility rigging to preserve names from
v1 of the backend, this allows old app urls to remain working.