Skip to content

Commit 257c958

Browse files
bzgBastien Guerry
andauthored
Readme updates (#428)
Co-authored-by: Bastien Guerry <[email protected]>
1 parent 3c4cc3e commit 257c958

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,45 @@
1+
[![img](https://img.shields.io/badge/We%20support-BlueHats-blue.svg)](https://bluehats.world)
2+
13
# Catalogi
24

35
## A Software Catalog application
46

5-
This repository contains the catalogi software, a web application to manage
6-
a catalog of software.
7+
This repository contains Catalogi, a web application to manage software catalogs.
8+
9+
![A screenshot of Catalogi for the SILL](catalogi.png)
710

8-
## Full documentation
11+
## Documentation
912

10-
The full documentation is available [here](https://codegouvfr.github.io/catalogi/)
13+
Documentation is available [here](https://codegouvfr.github.io/catalogi/)
1114

12-
## It is deployed on several places
15+
## Catalogi deployments
1316

14-
1. [https://code.gouv.fr/sill](https://code.gouv.fr/sill/) for the
15-
list of recommanded Free Software for French administrations.
16-
2. [https://logiciels.catalogue-esr.fr/](https://logiciels.catalogue-esr.fr/) for the French Research Minister, listing mostly HAL softwares.
17+
1. [https://code.gouv.fr/sill](https://code.gouv.fr/sill/) is the list of recommanded Free Software for French administrations.
18+
2. [https://logiciels.catalogue-esr.fr/](https://logiciels.catalogue-esr.fr/) list [HAL](https://hal.science/) for the French Ministry of Research.
1719

1820
## Code organization
1921

20-
This "monorepo" is made of several directories:
22+
This monorepo is made of several directories:
2123

22-
- api: Application API (also includes jobs, that can be run periodically)
23-
- web: Web frontend
24-
- docs: Documentation, as deployed [here](https://codegouvfr.github.io/catalogi/)
25-
- deploy-examples: Examples of deployment. For now, there is only a Docker Compose example.
24+
- `api/`: Application API (also includes jobs, that can be run periodically)
25+
- `web/`: Web frontend
26+
- `docs/`: Documentation, as deployed [here](https://codegouvfr.github.io/catalogi/)
27+
- `deploy-examples/`: Deployment examples. For now only a Docker Compose example.
2628

2729
## Governance and contributions
2830

2931
[![img](https://img.shields.io/badge/code.gouv.fr-contributif-blue.svg)](https://code.gouv.fr/documentation/#quels-degres-douverture-pour-les-codes-sources)
3032

31-
See [GOVERNANCE.md](GOVERNANCE.md) and [CONTRIBUTING.md](CONTRIBUTING.md).
33+
See [GOVERNANCE](GOVERNANCE.md) and [CONTRIBUTING](CONTRIBUTING.md).
34+
35+
## Discuss with us
36+
37+
You are welcome to join the [Catalogi Matrix channel](https://matrix.to/#/#catalogi:matrix.org).
3238

3339
## License
3440

3541
2021-2025 Direction interministérielle du numérique, mission logiciels libres.
3642

3743
The code in this repository is published under [licence MIT](LICENSES/MIT.txt).
3844

39-
The documentation is published under [licence Ouverte 2.0](LICENSES/Etalab-2.0.md) and CC-BY-4.0.
45+
The documentation is published under [licence Ouverte 2.0](LICENSES/Etalab-2.0.md) and [CC-BY-4.0](LICENSES/CC-BY-4.0.txt).

catalogi.png

158 KB
Loading

0 commit comments

Comments
 (0)