Search Unity

ReadMe...pdf,txt or md?

Discussion in 'Assets and Asset Store' started by garza, Sep 18, 2016.

?

what file type should the ReadMe file be in?

Poll closed Oct 2, 2016.

  1. pdf

    2 vote(s)
    50.0%

  2. txt

    1 vote(s)
    25.0%

  3. md

    1 vote(s)
    25.0%

  1. garza

    garza

    Joined:
    Dec 18, 2013
    Posts:
    30
    so let's pro and con this.

    pdf
    Pro:
    Everyone can open it.
    Can have images.
    Most web browsers can open it.
    Formatting (font sizes, bold, etc etc etc)
    Con:
    Not fast to open (pending on size).
    Adds to the size of the asset.

    txt
    Pro:
    Everyone can open it.
    Every computer can open it.
    Opens fast.
    Small file size.
    Con:
    No Images :(
    No formatting

    md
    Pro:
    Everyone can open it.
    Can have images. (images/videos do not add to file size)
    Every computer can open it.
    Opens fast.
    Small file size.
    Formatting (font sizes, bold, etc etc etc)
    Con:
    Basically an unknown file type.
     
    garza, Sep 18, 2016
    #1

  2. TonyLi

    TonyLi

    Joined:
    Apr 10, 2012
    Posts:
    12,699
    My suggestion:
    • Readme: txt file
    • Manual: pdf file
     
    TonyLi, Sep 19, 2016
    #2
    theANMATOR2b and garza like this.

  3. garza

    garza

    Joined:
    Dec 18, 2013
    Posts:
    30
    what's the difference between a ReadMe and a Manual?
     
    garza, Sep 19, 2016
    #3

  4. TonyLi

    TonyLi

    Joined:
    Apr 10, 2012
    Posts:
    12,699
    By "readme," I mean a short message to introduce the package. It usually has a brief note to the purchaser and describes where to find documentation and get support.

    By "manual," on the other hand, I mean detailed instructions, screenshots, etc.

    For an art asset, you might only need a readme. For anything more complex, such as art with configurable substances or variations, and certainly for any code asset, you need a manual.
     
    TonyLi, Sep 19, 2016
    #4