#21224 closed enhancement (wontfix)
[patch] Add markdown readme
Reported by: | gaben | Owned by: | team |
---|---|---|---|
Priority: | minor | Milestone: | |
Component: | Core | Version: | |
Keywords: | readme contribution markdown html ant | Cc: |
Description (last modified by ) ¶
Created a README.md
because it looks much better than a plaintext file :)
Please check the icon path in the first line is valid and working.
Change History (11)
comment:1 by , 4 years ago
Description: | modified (diff) |
---|
by , 4 years ago
Attachment: | JOSM markdown readme.patch added |
---|
by , 4 years ago
Attachment: | JOSM markdown readme v2.patch added |
---|
reflect changes made in the regular readme file
comment:2 by , 4 years ago
Summary: | Add markdown readme → [patch] Add markdown readme |
---|
follow-up: 6 comment:3 by , 4 years ago
Component: | unspecified → Core |
---|---|
Keywords: | readme contribution markdown html ant added |
It's not so simple, see #19941
As these text files are used in JOSM itself, the markdown should be converted to HTML at build time to be included in JOSM resources.
comment:4 by , 4 years ago
Where is it used and why? It's not clear from the linked issue. Btw it's about adding, not replacing ;)
Extra files shouldn't be the problem, as there is at least one, see ticket:20355#comment:6. And until r17976 it was in the root for more than 3 years.
comment:5 by , 4 years ago
It's used in the About dialog. I don't want to duplicate the information in two files, as I clearly want this file to be maintained (that's not the case of things like snapcraft and cie. that I don't care about).
comment:6 by , 4 years ago
Replying to Don-vip:
the markdown should be converted to HTML at build time to be included in JOSM resources.
Markdown supports HTML partially if that's the criteria.
comment:7 by , 4 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
We had this issue already before. The improvements in readability are too little compared to the drawbacks.
comment:8 by , 4 years ago
Last question; what's the purpose of having instructions on installing JOSM from a running JOSM instance?
comment:9 by , 4 years ago
That's simple. We don't want to have multiple files, so we put all that "whatever" stuff into one :-)
fixed paste issue