Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

is README (not README.md) outdated #154

Closed
Terracotta-Lite opened this issue Aug 4, 2023 · 1 comment
Closed

is README (not README.md) outdated #154

Terracotta-Lite opened this issue Aug 4, 2023 · 1 comment
Labels
bug Not working as advertised docs Documentation

Comments

@Terracotta-Lite
Copy link

There are two READMEs, one markdown document and one plain text. They conflict.

https://github.com/hpjansson/chafa/blob/master/README says I need ImageMagick whilst
https://github.com/hpjansson/chafa/blob/master/README.md says I don't.

I thought ImageMagick dependency was removed a while ago.

@hpjansson
Copy link
Owner

hpjansson commented Aug 4, 2023

Hi, thanks for reporting this. You're right, it's inconsistent. README.md is the up-to-date one -- ImageMagick is optional. I'll fix it shortly.

We have two readmes because what works well on the web (which is what most people will find at first), and what works in the terminal (which this, after all, is made for) are very different things. For instance, it's nice to be able to include images in the web version, but the resulting markdown looks terrible in the terminal.

There are MD converters for the terminal, but I don't know if there's one that counts as a gold standard that we can expect everyone to have installed already. If there is such a thing, and it works well, we could remove the plain README eventually.

@hpjansson hpjansson added bug Not working as advertised docs Documentation labels Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Not working as advertised docs Documentation
Projects
None yet
Development

No branches or pull requests

2 participants