Modify

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#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 gaben)

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.

Attachments (2)

JOSM markdown readme.patch (11.8 KB ) - added by gaben 4 years ago.
fixed paste issue
JOSM markdown readme v2.patch (11.2 KB ) - added by gaben 4 years ago.
reflect changes made in the regular readme file

Download all attachments as: .zip

Change History (11)

comment:1 by gaben, 4 years ago

Description: modified (diff)

by gaben, 4 years ago

Attachment: JOSM markdown readme.patch added

fixed paste issue

by gaben, 4 years ago

reflect changes made in the regular readme file

comment:2 by gaben, 4 years ago

Summary: Add markdown readme[patch] Add markdown readme

comment:3 by Don-vip, 4 years ago

Component: unspecifiedCore
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 gaben, 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 Don-vip, 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).

in reply to:  3 comment:6 by gaben, 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 stoecker, 4 years ago

Resolution: wontfix
Status: newclosed

We had this issue already before. The improvements in readability are too little compared to the drawbacks.

comment:8 by gaben, 4 years ago

Last question; what's the purpose of having instructions on installing JOSM from a running JOSM instance?

comment:9 by stoecker, 4 years ago

That's simple. We don't want to have multiple files, so we put all that "whatever" stuff into one :-)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain team.
as The resolution will be set.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.