expand readme, add accessibility section

This commit is contained in:
2026-03-14 20:26:27 +02:00
parent e00ba6b8bf
commit d84274db2e

View File

@@ -17,6 +17,7 @@ Looks like it was made this decade because it was.
[![React](https://img.shields.io/badge/React_19-61DAFB?style=flat-square&logo=react&logoColor=black)](https://react.dev)
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org)
[![Platform](https://img.shields.io/badge/Windows-0078D6?style=flat-square&logo=windows&logoColor=white)](#)
[![WCAG 2.2 AAA](https://img.shields.io/badge/WCAG_2.2-AAA-green?style=flat-square)](#-accessibility)
<br>
@@ -28,9 +29,13 @@ Looks like it was made this decade because it was.
## 🌱 Why another renaming tool?
Most bulk rename tools out there work fine. They also look like they were built in 2004 and never touched again. Some of them are great software by great people, and they got the job done for years. But the interfaces feel like operating heavy machinery.
There's no shortage of bulk rename software. Some of it has been around for 15-20 years, battle-tested and reliable. The problem isn't that these tools don't work - they do, and many of them are genuinely good at what they do.
Nomina is an attempt at something different - a renaming tool that feels like a normal, modern app. Dark mode that actually looks good. Animations that aren't janky. A UI that doesn't fight you. And the whole thing is CC0 public domain, which means it belongs to everyone equally and nobody can take that away.
The problem is that almost all of them look and feel like relics. Cramped toolbars, raw text fields, tiny buttons, modal dialogs stacked three deep. Interfaces designed around the constraints of an era when 1024x768 was a big screen and "usability" meant "it has a help file." They were fine for power users who learned the quirks, but they're hostile to everyone else. Renaming files is not a complicated task - the tools shouldn't make it feel like one.
And then there's the licensing situation. The free ones are usually freeware (closed source, owned by someone, could disappear or go paid tomorrow) or GPL (which is fine but comes with conditions that not everyone wants to deal with). The paid ones charge you for something that, frankly, your operating system should just do better in the first place.
Nomina tries to be the thing you'd build if you started from scratch today with no baggage. A proper dark mode, not a skin slapped on top of Win32 controls. Smooth animations. A layout that breathes. Drag-and-drop rule cards instead of cryptic option panels. Live preview that updates as you type. And CC0 public domain licensing, because a file renaming tool is not the kind of thing anyone should be able to own. It's a utility - it should be part of the commons.
## 🌿 What it does
@@ -63,34 +68,54 @@ Rules are draggable cards. Reorder them, toggle them on and off, duplicate them,
## 🍄 Not just renaming
- **Live preview** of every change before anything happens
- **Conflict detection** when two files would collide
- **Full undo** with persistent history across sessions
- **Presets** you can save, load, export as files, and share with anyone
- **Filters** by name pattern, regex, file size, type, and depth
- **Explorer integration** - "Edit in Nomina" in your right-click menu, auto-repairs if you move the exe
- **Accessibility** - screen reader support, keyboard navigation, high contrast, color blind modes, reduced motion (auto-detected from your OS), font scaling
- **Live preview** of every change before anything touches the disk
- **Conflict detection** when two files would end up with the same name
- **Full undo** with persistent history that survives app restarts
- **Presets** you can save, load, export as `.nomina` files, and share
- **Filters** by name pattern, regex, file size, type, and subfolder depth
- **Explorer integration** - "Edit in Nomina" in your Windows right-click menu, auto-repairs itself if you move the exe to a different location
- **Context menus** everywhere - right-click files, pipeline rules, and sidebar folders for quick actions
- **Drag and drop** reordering for pipeline rules
- **Automatic backups** before renaming, with configurable location and scheduled cleanup
- **Keyboard shortcuts** for common operations
## ♿ Accessibility
Nomina targets WCAG 2.2 AAA conformance. Accessibility isn't a feature you bolt on at the end - it's a baseline. Everyone who needs to rename files should be able to rename files, regardless of how they interact with their computer.
- **Screen reader support** - semantic markup, ARIA labels, and a live announcement region for status changes
- **Keyboard navigation** - full keyboard-only mode, visible focus indicators (with an enhanced option for higher visibility), tab ordering throughout
- **Reduced motion** - auto-detected from your OS preferences on first launch. Three levels: normal, reduced, and no motion at all. Respects `prefers-reduced-motion` automatically
- **High contrast** - toggleable high contrast mode with WCAG AAA contrast ratios (7:1 for normal text, 4.5:1 for large text). Also responds to `prefers-contrast` and `forced-colors` media queries
- **Color blind modes** - deuteranopia, protanopia, and tritanopia filters so color is never the only way information is conveyed
- **Font scaling** - adjustable from 80% to 150%, independent of the zoom level
- **Larger touch targets** - optional mode that increases clickable areas for people with motor difficulties
- **Reduced transparency** - removes glass and blur effects that can cause readability issues. Responds to `prefers-reduced-transparency`
- **Zoom** - the entire UI scales from 70% to 150% without breaking layout
The app reads your OS accessibility settings on first launch and configures itself to match - if you already have reduced motion or high contrast enabled system-wide, Nomina picks that up without you having to set it again.
## 🪨 Portable
Single exe. No installer. Put it anywhere. All its data (settings, presets, undo log) lives in a `data` folder next to the binary. Delete the folder, it's gone. Put it on a USB stick, it works. Move it, it works. The optional Explorer context menu is the one thing that touches the registry, and there's a button to cleanly remove it.
Single exe. No installer. Put it anywhere. All its data (settings, presets, undo log, webview cache) lives in a `data` folder next to the binary. Delete the folder, it's gone. Put it on a USB stick, it works. Move it to another machine, it works. Your settings travel with you.
The optional Explorer context menu is the one thing that touches the registry (because that's how Windows works), and there's a button to cleanly remove it. After that, your system is exactly as it was before.
## 🍵 Configurable
Dark, light, or match-your-system theme. Adjustable accent color. Zoom from 70% to 150%. Compact mode. Zebra striping. Configurable preview delay, sort order, conflict handling, backup strategy with scheduled cleanup, undo depth, notification preferences. About 80 settings in total, all stored locally next to the exe.
Dark, light, or match-your-system theme. Adjustable accent color hue. Zoom from 70% to 150%. Compact mode for smaller screens. Zebra striping on the file list. Configurable preview delay, default sort order, conflict handling strategy, backup location with scheduled cleanup, undo history depth, notification preferences (toasts, taskbar flash, sound). About 80 settings total, all stored locally next to the exe.
## 🌻 Public domain
Nomina is released under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/). No rights reserved. No contributor license agreements. No corporate ownership. No "open core" bait-and-switch where the good parts cost money.
The code is a common resource. Fork it, modify it, redistribute it, learn from it, build something better. You don't need to ask, and there's nothing to sign. Software that people need should be free to use, free to study, free to share, and free to improve. That's not a business model - it's just how things should work.
The code is a common resource. Fork it, modify it, redistribute it, learn from it, build something better with it. You don't need to ask, and there's nothing to sign. Software that people need every day should be free to use, free to study, free to share, and free to improve - not because that's a clever business strategy, but because that's the only arrangement that actually respects the people using it.
Tools belong to the people who use them. Always have.
---
<details>
<summary><strong>🔧 Building from source</strong></summary>
<br>
## 🔧 Building from source
### Prerequisites
@@ -126,6 +151,4 @@ nomina/
ui/ # React + TypeScript frontend
```
`nomina-core` is a standalone library that handles renaming logic, pipeline execution, filters, undo, and presets. The `nomina` crate wraps it in a Tauri window. The `ui` folder is the frontend. The engine doesn't depend on the UI, so you could build a CLI or a different frontend on top of it if you wanted.
</details>
`nomina-core` is a standalone library that handles renaming logic, pipeline execution, filters, undo, and presets. The `nomina` crate wraps it in a Tauri window. The `ui` folder is the frontend. The engine doesn't depend on the UI, so you could wire up a CLI or a different interface on top of it if you wanted to.