Skip to content

Commit b427fad

Browse files
committed
chore(README): remove deprecated content (#203)
Removed breaking change notice and outdated sections from README.
1 parent 60c1ebc commit b427fad

File tree

1 file changed

+17
-58
lines changed

1 file changed

+17
-58
lines changed

README.md

Lines changed: 17 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
1-
<!--TODO: Remove the section below after #139 (which replaced #93) is merged on 22 Dec 2025 - wait 2 weeks, so remove this on 5 Jan 2026 -->
2-
3-
> [!CAUTION]
4-
> ⚠️⚠️⚠️ **Breaking Change in [PR #93](https://github.com/Ryan-Millard/Img2Num/pull/93)** ⚠️⚠️⚠️
5-
>
6-
> The Makefile behavior is changing soon.
7-
>
8-
> Please read issues [#107](https://github.com/Ryan-Millard/Img2Num/pull/107) and [#109](https://github.com/Ryan-Millard/Img2Num/pull/109) before running the code.
1+
<div align="center">
92

10-
# Img2Num 🦔🖼️➞️🎨
3+
<img src="https://github.com/user-attachments/assets/d75b402e-03af-403f-8637-f9eb8a24c8c0" alt="Logo" height="150px" />
114

12-
<div align="center">
5+
# Img2Num
136

147
[![Site Badge](https://img.shields.io/badge/site-online-blue.svg)](https://ryan-millard.github.io/Img2Num/)
158
[![Docs Badge](https://img.shields.io/badge/docs-online-blue.svg)](https://ryan-millard.github.io/Img2Num/info/)
169
[![License Badge](https://img.shields.io/badge/license-AGPLv3-blue.svg)](LICENSE)
17-
[![Release](https://img.shields.io/github/v/release/Ryan-Millard/Img2Num?sort=semver)](https://github.com/Ryan-Millard/Img2Num/releases)
18-
19-
[![GitHub stars](https://img.shields.io/github/stars/Ryan-Millard/Img2Num?style=social)](https://github.com/Ryan-Millard/Img2Num/stargazers)
20-
[![GitHub forks](https://img.shields.io/github/forks/Ryan-Millard/Img2Num?style=social)](https://github.com/Ryan-Millard/Img2Num/network/members)
21-
[![Contributors](https://img.shields.io/github/contributors/Ryan-Millard/Img2Num)](https://ryan-millard.github.io/Img2Num/credits)
22-
[![GitHub issues](https://img.shields.io/github/issues/Ryan-Millard/Img2Num)](https://github.com/Ryan-Millard/Img2Num/issues)
2310

2411
</div>
2512

@@ -64,34 +51,17 @@
6451
</tr>
6552
</table>
6653

54+
<div align="center">
55+
6756
### What are you waiting for?
6857

6958
Try it out now by [clicking here](https://ryan-millard.github.io/Img2Num/)!
7059

71-
## What this repository contains (short)
72-
73-
<div align="center" />
74-
75-
![React](https://img.shields.io/badge/React-19-blue?logo=react&logoColor=61DAFB)
76-
![C++](https://img.shields.io/badge/C++-Modern-blue?logo=c%2B%2B&logoColor=00599C)
77-
![WebAssembly](https://img.shields.io/badge/WebAssembly-Yes-blue?logo=webassembly)
78-
![JavaScript](https://img.shields.io/badge/JavaScript-ES6-yellow?logo=javascript&logoColor=black)
79-
![Node.js](https://img.shields.io/badge/Node.js-20-green?logo=node.js&logoColor=white)
80-
![Vite](https://img.shields.io/badge/Vite-7-purple?logo=vite)
81-
![CSS](https://img.shields.io/badge/CSS-Modern-blue?logo=css3)
82-
8360
</div>
84-
<div align="center" />
8561

86-
![Prettier](https://img.shields.io/badge/Prettier-Code%20Formatter-brightgreen?logo=prettier&logoColor=F7B93E)
87-
![ESLint](https://img.shields.io/badge/ESLint-Linted-yellow?logo=eslint)
88-
![Vitest](https://img.shields.io/badge/Vitest-Tested-orange?logo=vitest)
89-
![Docusaurus](https://img.shields.io/badge/Docusaurus-Docs-blue?logo=docusaurus)
90-
![Concurrently](https://img.shields.io/badge/Concurrently-MultiTask-orange?logo=github-actions)
91-
![EditorConfig](https://img.shields.io/badge/EditorConfig-Style-blue?logo=editorconfig)
92-
![Clang-Format](https://img.shields.io/badge/Clang%20Format-Formatted-blue?logo=clang)
62+
---
9363

94-
</div>
64+
## What this repository contains (short)
9565

9666
- A React frontend that handles image input, preview and in-browser colouring.
9767
- A WebAssembly module (C++ → Emscripten) that performs image processing and colour quantisation.
@@ -102,48 +72,37 @@ This README is intentionally short — full installation steps, guides and refer
10272

10373
Visit the docs site for full guides, API references and troubleshooting:
10474

105-
- Quick start - [https://ryan-millard.github.io/Img2Num/info/docs/getting-started/](https://ryan-millard.github.io/Img2Num/info/docs/introduction/getting-started)
106-
- Guidelines - [https://ryan-millard.github.io/Img2Num/info/docs/category/-guidelines/](https://ryan-millard.github.io/Img2Num/info/docs/category/-guidelines)
107-
- Documentation - [https://ryan-millard.github.io/Img2Num/info/docs/](https://ryan-millard.github.io/Img2Num/info/docs/)
108-
- Reference & Advanced Guides - [https://ryan-millard.github.io/Img2Num/info/docs/reference/](https://ryan-millard.github.io/Img2Num/info/docs/reference/)
109-
- Changelog - [https://ryan-millard.github.io/Img2Num/info/docs/changelog/](https://ryan-millard.github.io/Img2Num/info/changelog)
110-
111-
(These replace long, duplicate instructions in this README to keep maintenance easier.)
75+
- [Quick start](https://ryan-millard.github.io/Img2Num/info/docs/introduction/getting-started)
76+
- [Guidelines](https://ryan-millard.github.io/Img2Num/info/docs/category/-guidelines)
77+
- [Documentation](https://ryan-millard.github.io/Img2Num/info/docs/)
78+
- [Reference & Advanced Guides](https://ryan-millard.github.io/Img2Num/info/docs/reference/)
79+
- [Changelog](https://ryan-millard.github.io/Img2Num/info/changelog)
11280

11381
## Contributing
11482

115-
We welcome contributions. Please read [CONTRIBUTING.md](https://ryan-millard.github.io/Img2Num/info/docs/guidelines/contributing) and the pinned issues before opening issues or pull requests.
83+
We welcome contributions from all places. Please read the [Contribution Guidelines](https://ryan-millard.github.io/Img2Num/info/docs/guidelines/contributing) and the pinned issues before opening issues or pull requests.
11684

11785
**A few important points:**
11886

11987
- **Add tests** with your PR — new features and bug fixes **must** include tests where appropriate. PRs without tests are unlikely to be approved.
12088
- Follow the repository's [coding style rules](https://ryan-millard.github.io/Img2Num/info/docs/guidelines/coding-style) and [commit message rules](https://ryan-millard.github.io/Img2Num/info/docs/guidelines/commits).
12189
- Use the issue and PR templates when filing issues or submitting code. Your PR will be rejected if you don't.
12290

123-
If you're unsure what to change, open an issue first and we can discuss scope.
91+
If you're unsure what to change, [open a discussion](https://github.com/Ryan-Millard/Img2Num/discussions/new/choose) and someone will assist you.
12492

12593
## License
12694

12795
[AGPLv3](https://ryan-millard.github.io/Img2Num/info/docs/license)
12896

129-
## What we intentionally keep out of this README
130-
131-
- Long, step‑by‑step build instructions (moved to the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/))
132-
- Full API reference (moved to the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/reference))
133-
- Very large images or heavy explanations — use the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/) for in-depth content
134-
13597
## Can't find something?
13698

137-
Hopefully you understand by now that if you need something, it should be on the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/).
138-
If it isn't, please open a ["New Feature" issue](https://github.com/Ryan-Millard/Img2Num/issues/new?template=feature_request.yml) to request its addition to the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/).
99+
If you need something, you should be able to find it on the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/).
100+
If it isn't there, please open a ["New Feature" issue](https://github.com/Ryan-Millard/Img2Num/issues/new?template=feature_request.yml) to request its addition to the [docs site](https://ryan-millard.github.io/Img2Num/info/docs/) and someone will assist you with finding what you need.
139101

140102
## Maintainers
141103

142104
- [Ryan](https://github.com/Ryan-Millard/)
143-
- [Hayden](https://github.com/hjmillard/) (temporarily unavailable)
144-
145-
> ⚠️ **Disclaimer:** Pull request reviews may take some time as we try to keep up with contributions.
146-
> We highly encourage everyone to review each other's pull requests where possible — this helps the project move faster and benefits all contributors in the long run. Thank you for your support!
105+
- [Hayden](https://github.com/hjmillard/)
147106

148107
## Contributors & Credits
149108

0 commit comments

Comments
 (0)