diff options
| author | Richard Hughes <richard@hughsie.com> | 2014-03-18 13:36:00 +0000 |
|---|---|---|
| committer | Richard Hughes <richard@hughsie.com> | 2014-03-18 13:36:00 +0000 |
| commit | fc8107a6032117c0b972a1063fdf67f2df30f9a5 (patch) | |
| tree | bcf4bdfeb9ca8303c5831e7fca5ace2a408c95cb /docs | |
| parent | 3bd7010c35ff0cc7458716a3ec17834fed6a6c57 (diff) | |
| download | appstream-glib-fc8107a6032117c0b972a1063fdf67f2df30f9a5.tar.gz | |
Add a simple HTML project page
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/html/common.css | 102 | ||||
| -rw-r--r-- | docs/html/index.htm | 87 | ||||
| -rwxr-xr-x | docs/html/upload.sh | 2 |
3 files changed, 191 insertions, 0 deletions
diff --git a/docs/html/common.css b/docs/html/common.css new file mode 100644 index 0000000..58b01d8 --- /dev/null +++ b/docs/html/common.css @@ -0,0 +1,102 @@ +/* common.css - MoinMoin Default Styles + + Copyright (c) 2001, 2002, 2003 by Jürgen Hermann +*/ + +/* content styles */ + +html { + background-color: white; + color: black; +} + +h2 { + font-size: 1.6em; +} + +h3 { + font-size: 1.3em; +} + +h4, h5, h6 { + font-size: 1em; +} + +li p { + margin: .2em 0; +} + +li.gap { + margin-top: 8pt; +} + +a img { + border: 0; +} + +img.drawing { + border: 0; +} + +dt { + font-weight: bold; +} + +pre { + padding: .5em; + white-space: pre-wrap; +} + +body { + margin-top: 2em; + margin-left: 5%; + margin-right: 5%; +} + +h1, h2, h3, h4, h5, h6 { + color: #2b5e82; +} + +a:link { + background-color: inherit; + color: #2b5e82; +} + +a:visited { + background-color: inherit; + color: #52188b; +} + +pre { + border: 1px solid #CBCBCB; + background-color: #FFF8ED; + color: black; +} + +hr { + clear: both; + border-style: none; + background-color: #CBCBCB; + color: #CBCBCB; +} + +p.footer { + color: #000000; + text-align: center; + font-size: 9px; +} + +table { + border: 0; + width: 100%; +} +.center { + text-align: center; +} +div.nav a { + border-right: 1px solid black; + padding-right: 4px; +} +div.nav :last-child { + border-right: none; +} diff --git a/docs/html/index.htm b/docs/html/index.htm new file mode 100644 index 0000000..ff1e30c --- /dev/null +++ b/docs/html/index.htm @@ -0,0 +1,87 @@ +<!doctype html> +<html> + <head> + <meta charset="utf-8"> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <meta name="robots" content="index,follow"> + <link rel="stylesheet" type="text/css" media="all" href="common.css"> + <title>AppStream-Glib</title> + </head> + <body> + <div class="nav center"> + <a href="index.htm">Homepage</a> + <a href="docs/">Documentation</a> + <a href="releases/">Releases</a> + <a href="https://github.com/hughsie/appstream-glib">Browse source code</a> + </div> + <h1>AppStream-Glib</h1> + <p> + This library provides GObjects and helper methods to make it easy to read and + write AppStream metadata. It also provides a simple DOM implementation that + makes it easy to edit nodes and convert to and from the standardized XML + representation. + </p> + <p> + What this library allows you to do: + </p> + <ul> + <li>Read and write compressed AppStream XML files</li> + <li>Add and search for applications in an application store</li> + <li>Get screenshot image data and release announcements</li> + <li>Easily retrieve the best application data for the current locale</li> + <li>Efficiently interface with more heavy-weight parsers like expat</li> + </ul> + <p> + For more information about what AppStream is, please see the + <a href="http://www.freedesktop.org/wiki/Distributions/AppStream/">wiki</a>. + </p> + + <h2>Getting Started</h2> + <p> + To install the libappstream-glib library you either need to install the + <code>libappstream-glib</code> package from your distributor, or you can build a local + copy. To do the latter just do: +<pre> +dnf install automake autoconf libtool glib-devel +./autogen.sh +make +make install +</pre> + + <h2>More Information</h2> + <p> + If you want to actually generate metadata rather than just consuming it, you + probably want to be looking at + <a href="https://github.com/hughsie/createrepo_as">createrepo_as</a> or if + you're completely lost, GNOME Software is a GUI tool that uses this library to + implement a software center. See <code>src/plugins/gs-plugin-appstream.c</code> if you + want some more examples on using this library where speed and latency really + matter. + </p> + + <h2>Hacking</h2> + <p> + If you want a new feature, or have found a bug or a way to crash this library, + please report as much information as you can to the + <a href="https://github.com/hughsie/appstream-glib/issues">issue tracker</a> + - patches very welcome. + </p> + <p> + New functionality or crash fixes should include a test in `src/as-self-test.c` + to ensure we don't regress in the future. New functionality should also be + thread safe and also not leak *any* memory for success or failure cases. + </p> + + <h2>License</h2> + <p> + LGPLv2+ + </p> + + <p class="footer"> + Copyright <a href="mailto:richard@hughsie.com">Richard Hughes 2007-2014</a><br> + <a href="http://validator.w3.org/check/referer">Optimized</a> + for <a href="http://www.w3.org/">standards</a>. + </p> + </body> +</html> + diff --git a/docs/html/upload.sh b/docs/html/upload.sh new file mode 100755 index 0000000..61e6126 --- /dev/null +++ b/docs/html/upload.sh @@ -0,0 +1,2 @@ +scp -r *.htm *.css hughsient@people.freedesktop.org:~/public_html/appstream-glib +scp ../api/html/* hughsient@people.freedesktop.org:~/public_html/appstream-glib/docs |