Skip to content

Commit

Permalink
Add project introduction (#660)
Browse files Browse the repository at this point in the history
  • Loading branch information
nwagner84 authored Jul 14, 2023
1 parent dc19e4c commit f616904
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/book/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ main h2, h3 {
}

.content ul li {
padding: 5px 0px;
/* padding: 5px 0px; */
}
26 changes: 26 additions & 0 deletions docs/book/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# pica-rs

[![CI](https://github.com/deutsche-nationalbibliothek/pica-rs/workflows/CI/badge.svg?branch=main)](https://github.com/deutsche-nationalbibliothek/pica-rs/actions?query=workflow%3ACI+branch%3Amain)
[![Documentation](https://img.shields.io/badge/Documentation-main-orange.svg)](https://deutsche-nationalbibliothek.github.io/pica-rs/)
[![dependency status](https://deps.rs/repo/github/deutsche-nationalbibliothek/pica-rs/status.svg)](https://deps.rs/repo/github/deutsche-nationalbibliothek/pica-rs)

Das Toolkit _pica-rs_ ermöglicht eine effiziente Verarbeitung von
bibliografischen Metadaten, die in PICA+, dem internen Format des
[_OCLC_]-Katalogsystems, kodiert sind. Mit Hilfe verschiedener
[_Kommandos_] können aus den Metadaten elementare statistische Größen
ermittelt und aufbereitet werden. Zudem kann das Toolkit als
Brückentechnologie fungieren, um Metadaten für populäre Frameworks wie
[_Pandas_] oder [_Polars_] (Python), in Programmiersprachen wie [_R_]
oder für Excel nutzbar zu machen. Darüber hinaus eignet sich das Toolkit
für die Automatisierung von Metadaten-Workflows.

## Verwandte Projekte

- [Catmandu::Pica](https://metacpan.org/pod/Catmandu::PICA) — Catmandu modules for working with PICA+ data
- [Metafacture](https://github.com/metafacture) — Tool suite for metadata processing

[_Kommandos_]: referenz/kommandos/index.md
[_OCLC_]: https://www.oclc.org/de/
[_Pandas_]: https://pandas.pydata.org/
[_Polars_]: https://www.pola.rs/
[_R_]: https://www.r-project.org/
15 changes: 9 additions & 6 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Summary

- [Tutorials](./tutorials/index.md)
[Einführung](./README.md)

- [Anleitungen](./anleitungen/index.md)
- [Installation](./anleitungen/installation.md)
<!-- # Tutorials -->

- [Referenz](./referenz/index.md)
- [Kommandos](./referenz/kommandos/index.md)
- [cat](./referenz/kommandos/cat.md)
# Anleitungen

- [Installation](./anleitungen/installation.md)

# Referenz
- [Kommandos](./referenz/kommandos/index.md)
- [cat](./referenz/kommandos/cat.md)
6 changes: 2 additions & 4 deletions docs/book/src/referenz/kommandos/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Kommandos

Das Programm `pica` (bzw. `pica.exe`) stellt über verschiedene Kommandos
Funktionen zur Verarbeitung von bibliographischen Datensätzen, die in
PICA+ kodiert sind, zur Verfügung.
## Übersicht

* [cat](./cat.md) — Zusammenfügen (konkatenieren) von Datensätzen
* [cat](./cat.md) — Zusammenfügen (Konkatenieren) von Datensätzen

0 comments on commit f616904

Please sign in to comment.