cc:readme

Struktura souboru README.md

Pro datasety

## Overview
Stručné shrnutí obsahu datasetu, účel a omezení.

## Methods
- Design studie a populace/vzorek
- Protokol sběru dat (přístroje, nastavení, prostředí)
- Předzpracování (filtry, normalizace, anonymizace, verze SW)
- Kontrola kvality

## Data structure
- Seznam souborĹŻ a sloĹľek s popisem
- Formáty a jednotky
- Datový slovník (názvy proměnných, kódy, chybějící hodnoty)

## Usage
- Jak data načíst (ukázka kódu, např. Python/pandas)
- Požadavky na software nebo závislosti
- Známá omezení pro re-use

## Version history
- v1.0 (YYYY-MM-DD): První vydání

## Contact
Kontaktní osoba – e-mail

Pro software

## Overview
Popište účel a hlavní funkce software. Uveďte rozsah a omezení.

## Requirements
- ProgramovacĂ­ jazyk a verze
- Závislosti (knihovny, frameworky)
- OS / HW poĹľadavky

## Installation
Kroky instalace nebo nastavenĂ­.

## Usage
- Příklad spuštění příkazu/skriptu
- Vstupy a očekávané výstupy

## Repository structure
- `src/` – zdrojové kódy
- `examples/` – příklady použití
- `docs/` – dokumentace (pokud je)

## Version history
- v1.0 (YYYY-MM-DD): První vydání

## Contact
Kontaktní osoba – e-mail
  • cc/readme.txt
  • Last modified: 2025/10/07 15:52
  • by klajnos