Commit 0dc714f4 authored by Etalab's avatar Etalab

update README

parent 88655b06
......@@ -8,28 +8,32 @@ The database can be explored on a web interface at (code.gouv2.fr)[[https://code
The main effort on this project is put on adding more and more sources to the database. All the informations gathered should allow to build an list of programs and their objective characteristics, which can be used with confidence by users in order to evaluate software solutions.
## Sources
The data from each source is kept in YAML its own git repository in order to preserve history. Another repository contains the script which extract the data from the source. We do not impose structure on the data. As much as possible, we preserve the original structure of the source in order to never destroy data in the process.
The script [merge-open-software-base-yaml](https://git.framasoft.org/codegouv/merge-open-software-base-yaml) generate the present repository from all the other source repositories. This script generates a YAML file for each program, with the raw data from each source written under a key named after this source. It also generates a `canonical` key which synthesizes data from various sources based on predefined priorities. The best explanation is [an example of such a file](https://git.framasoft.org/codegouv/open-software-base-yaml/blob/master/cups.yaml).
### Source list
#### Ultimate Debian Database
#### [Ultimate Debian Database](https://wiki.debian.org/UltimateDebianDatabase)
* Script: https://git.framasoft.org/codegouv/udd-to-yaml
* Data: https://git.framasoft.org/codegouv/udd-yaml
#### Appstream Debian
#### [Appstream Debian](https://wiki.debian.org/AppStream)
* Script: https://git.framasoft.org/codegouv/appstream-debian-to-yaml
* Data: https://git.framasoft.org/codegouv/appstream-debian-yaml
#### Wikidata
#### [Wikidata](https://www.wikidata.org/wiki/Wikidata:Main_Page)
* Script: https://git.framasoft.org/codegouv/wikidata-to-yaml
* Data: https://git.framasoft.org/codegouv/wikidata-yaml
#### [Civicstack](http://www.civicstack.org/)
* Script: https://git.framasoft.org/codegouv/civicstack-to-yaml
* Data: https://git.framasoft.org/codegouv/civicstack-yaml
#### Contributions
The Open Software Base is also opened to programs added by users which are not present in either automated sources. This source, as the other ones, takes the form of a git repository containing YAML files. You are invited to fork this repository and create merge request in order to add informations. Merge request are validated by a script which check that basic informations are present.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment