613328 - readme.txt content is obsolete

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

The content of the readme.txt file is obsolete, as it says a bunch of things that are not relevant to SDK users.  It should be updated to be relevant to such users.

Comment 1

[Atul Varma [:atul]]

Hey, while we're doing this, I'm wondering if it'd be useful to actually rename the file to README.md, allowing us to use Markdown in the content. One particular advantage of this is that github automatically renders it as Markdown at the project page, which looks nicer than monospaced plaintext and can also be significantly more readable.

Comment 2

[Myk Melez [:myk] [@mykmelez]]

(In reply to comment #1)
> Hey, while we're doing this, I'm wondering if it'd be useful to actually rename
> the file to README.md, allowing us to use Markdown in the content. One
> particular advantage of this is that github automatically renders it as
> Markdown at the project page, which looks nicer than monospaced plaintext and
> can also be significantly more readable.

It's a good idea, and Markdown is relatively human-readable, but I'd still want to convert it into a plaintext file for the downloadable package, which means introducing a build step, and that's a larger change than we should be making at this point in the current development cycle.  It also isn't a beta blocker, so let's do it separately in a subsequent cycle.

Comment 3

[Atul Varma [:atul]]

I'd actually argue that, since Markdown was "reverse-engineered" based on the way people write plain-text emails, simply renaming our README.txt to README.md would probably make the github project page look a lot nicer, but either way it's not that big a deal.