Evolinx/appstream-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
210 Commits 1 Branch 0 Tags 2.8 MiB
D 90.4%
HTML 4.4%
CSS 1.9%
Shell 1.5%
Meson 1.4%
Other 0.4%
f3b859c199
Go to file
Matthias Klumpp f3b859c199 Add link to D tour
2016-05-25 16:56:46 +02:00
contrib run bower with allow root to be able to make js as root 2016-05-24 13:39:47 +02:00
data Catch data serialization errors 2016-05-22 22:45:02 +02:00
docs Allow disabling metadata timestamps 2016-05-24 18:46:45 +02:00
source trivial: Use D-style syntax in test 2016-05-25 00:07:55 +02:00
test/samples Add some font rendering experiments 2016-05-20 03:41:46 +02:00
.gitignore Add initial code and primitives 2016-03-03 20:59:03 +01:00
.gitmodules Store YAML hints data in the database 2016-03-09 22:06:07 +01:00
.travis.yml travis: Test installation 2016-04-19 00:15:46 +02:00
dub.json Add some font rendering experiments 2016-05-20 03:41:46 +02:00
LICENSE Update license 2016-03-03 20:59:11 +01:00
MAINTAINERS Add more documentation 2016-03-29 03:09:26 +02:00
Makefile trivial: Mark test target as phony 2016-04-22 19:42:42 +02:00
NEWS Release version 0.3.0 2016-05-24 19:52:46 +02:00
README.md Add link to D tour 2016-05-25 16:56:46 +02:00
RELEASE trivial: post release version bump 2016-05-24 19:53:57 +02:00
TODO Update TODO 2016-05-23 21:10:11 +02:00

README.md

AppStream Generator

AppStream is an effort to provide additional metadata and unique IDs for all software available in a Linux system. This repository contains the server-side of the AppStream infrastructure, a tool to generate metadata from distribution packages. You can find out more about AppStream distro metadata at Freedesktop.

The AppStream generator is currently primarily used by Debian, but is written in a distribution agnostic way. Backends only need to implement two interfaces to to be ready.

If you are looking for the AppStream client-tools, the AppStream repository is where you want to go.

AppStream Generator Logo

Development

Build Status

Build dependencies

  • gdc / ldc
  • dub 1
  • glib2 (>= 2.46)
  • AppStream 2
  • libarchive 3
  • LMDB 4
  • Cairo
  • GdkPixbuf 2.0
  • RSvg 2.0
  • Bower (optional) 5

On Debian and derivatives of it, all build requirements can be installed using the following command:

sudo apt install dub libappstream-dev libgdk-pixbuf2.0-dev libarchive-dev \
    librsvg2-dev liblmdb-dev libglib2.0-dev libcairo2-dev libcurl4-gnutls-dev

Build instructions

Ensure you have initialized the Git submodules. Run make update-submodule to run a fake-target which initializes and updates the submodule. Then run dub build or make to build the software - if all dependencies are set up correctly, the binary will be built and stored as build/appstream-generator, and can be used directly from there.

If you want to use the HTML reports, you need to install Bower, then run make js to download the JavaScript bits and store them in the right directory. If you want, you can also install the generator system-wide using make install. In summary:

$ make update-submodule
$ dub build --parallel
$ make js
$ sudo make install

Usage

Take a look at the docs/ directory in the source tree for information on how to use the generator. Right now, only the YAML output format is tested properly.

Hacking

Pull-requests and patches are very welcome! If you are new to D, it is highly recommended to take a few minutes to look at the D tour to get a feeling of what the language can do: http://tour.dlang.org/