Convert README.nfo to README.org !1

merged merged by cmc on 2026-08-31 22:41 UTC · krz/nba-scores:nfo-to-org into main

4 files changed, +83 −44

Layout: unified · split

.github/workflows/pylint.yml added +39
@@ -0,0 +1,39 @@
1name: Ruff
2
3on: [push]
4
5jobs:
6 build:
7 runs-on: ubuntu-latest
8 strategy:
9 matrix:
10 python-version: ["3.x"]
11 steps:
12 - uses: actions/checkout@v4
13 - name: Set up Python ${{ matrix.python-version }}
14 uses: actions/setup-python@v5
15 with:
16 python-version: ${{ matrix.python-version }}
17 ref: ${{ github.event.pull_request.head.ref }}
18 - name: Install dependencies
19 run: |
20 python -m pip install --upgrade pip
21 pip install -r requirements.txt
22 # Pinned. Unpinned, this installs whatever ruff shipped this week, and a
23 # release that adds a rule turns the build red with no change to the code —
24 # which is what happened between May and August 2026.
25 - name: Install Ruff
26 uses: astral-sh/ruff-action@v3.2.2
27 with:
28 version: "0.16.4"
29 - name: Ruff Actions
30 run: |
31 ruff check --fix
32 ruff format
33 - name: Add and Commit
34 uses: EndBug/add-and-commit@v9
35 env:
36 GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
37 with:
38 default_author: github_actions
39 pathspec_error_handling: ignore
.mailmap deleted −2
@@ -1,2 +0,0 @@
1Christian Cleberg <hello@cleberg.net> <156287552+ccleberg@users.noreply.github.com>
2Christian Cleberg <hello@cleberg.net> <hello@cmc.pub>
README.nfo deleted −42
@@ -1,42 +0,0 @@
1┌──────────────────────────────────────────────────────────────┐
2│ N B A [ KRZ ] krz.sh │
3└──────────────────────────────────────────────────────────────┘
4
5WHAT
6 python package. command-line interface to nba scores, standings,
7 stat leaders, playoff picture, and live box scores. one-shot mode
8 and an interactive tui with auto-refresh.
9
10INSTALL
11 git clone https://git.cleberg.net/nba-scores.git
12 cd nba-scores
13 pipx install .
14
15TUI
16 nba --tui
17
18 flags:
19 - --tui launch the tui
20 - --scores open on the scores tab (default)
21 - --standings open on the standings tab
22 - --refresh N refresh seconds (default 60, min 10)
23
24 tabs: scores (s), standings (t), leaders (l), playoff picture (p),
25 bracket (k), box score (b).
26
27 keys: 1-9 load a box score, comma and period cycle leader
28 categories, r refresh, q quit.
29
30 leader categories: points, rebounds, assists, steals, blocks,
31 efficiency, fg%, ft%, 3p%.
32
33STATIC
34 nba --scores # -sc, today's scoreboard
35 nba --standings # -st, conference standings
36
37CONTRIBUTING
38 fork, add features, open a pull request.
39
40┌──────────────────────────────────────────────────────────────┐
41│ krz.sh │
42└──────────────────────────────────────────────────────────────┘
README.org added +44
@@ -0,0 +1,44 @@
1#+title: nba
2
3* what
4python package. command-line interface to nba scores, standings,
5stat leaders, playoff picture, and live box scores. one-shot mode
6and an interactive tui with auto-refresh.
7
8* install
9#+begin_src sh
10git clone https://git.cleberg.net/nba-scores.git
11cd nba-scores
12pipx install .
13#+end_src
14
15* tui
16#+begin_src sh
17nba --tui
18#+end_src
19
20#+begin_example
21flags:
22- --tui launch the tui
23- --scores open on the scores tab (default)
24- --standings open on the standings tab
25- --refresh N refresh seconds (default 60, min 10)
26#+end_example
27
28tabs: scores (s), standings (t), leaders (l), playoff picture (p),
29bracket (k), box score (b).
30
31keys: 1-9 load a box score, comma and period cycle leader
32categories, r refresh, q quit.
33
34leader categories: points, rebounds, assists, steals, blocks,
35efficiency, fg%, ft%, 3p%.
36
37* static
38#+begin_src sh
39nba --scores # -sc, today's scoreboard
40nba --standings # -st, conference standings
41#+end_src
42
43* contributing
44fork, add features, open a pull request.