Skip to content

Commit

Permalink
Updated READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
antoninkriz committed Aug 29, 2023
1 parent 90e5a6b commit faf127f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,22 @@
Harder, better, faster, stronger


## Usage

Just open [the website](https://antoninkriz.github.io/CTU-TimeTable-Generator/) - no more downloading, installing, compiling, generating auth tokens and crying!


## Data

You don't need to login or generate any auth tokens. The data are fetched every 2 hours or so (check [`fetch-data.yml`](https://github.com/antoninkriz/CTU-TimeTable-Generator/blob/main/.github/workflows/fetch-data.yml)) from the KOS API. If you have a better strategy, which doesn't include frying the KOS API every minute, please let me know. ❤


## Components

- `kos-loader` - Loads data from the KOS API
- `ctu-timetable-generator` - User-facing app


## Development

See `README.md` in each component's folder.
6 changes: 6 additions & 0 deletions ctu-timetable-generator/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# ctu-timetable-generator

[![ci-web](https://github.com/antoninkriz/CTU-TimeTable-Generator/actions/workflows/ci-web.yml/badge.svg)](https://github.com/antoninkriz/CTU-TimeTable-Generator/actions/workflows/ci-python.yml)
[![Next JS](https://img.shields.io/badge/Next-black?logo=next.js&logoColor=white)](https://nextjs.org/)
[![React](https://img.shields.io/badge/react-%2320232a.svg?logo=react&logoColor=%2361DAFB)](https://react.dev/)
[![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?logo=yarn&logoColor=white)](https://yarnpkg.com/)
[![ESLint](https://img.shields.io/badge/ESLint-4B3263?logo=eslint&logoColor=white)](https://eslint.org/)

Front-end Web App for **CTU TimeTable Generator**

---
Expand Down
6 changes: 6 additions & 0 deletions kos-loader/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# kos-loader

[![ci-python](https://github.com/antoninkriz/CTU-TimeTable-Generator/actions/workflows/ci-python.yml/badge.svg)](https://github.com/antoninkriz/CTU-TimeTable-Generator/actions/workflows/ci-python.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)

Data loader for **CTU TimeTable Generator**

---
Expand Down

0 comments on commit faf127f

Please sign in to comment.