4
\$\begingroup\$

I want to write a very small and amateur game for toddlers and I want to make it open source.

I'm trying to figure out what I need to put in the README.md. A general approach could be:

Building a Peanut Butter and Jelly Sandwich

Introduction

In this project, you will build a Peanut Butter and Jelly Sandwich (PB&J).

Getting Started

Before you build a PB&J, you will need to:
YOUR WORKING ENVIRONMENT HERE

Dependencies

In order to build a PB&J, you will need the following supplies:
YOUR INGREDIENTS HERE

Instructions

Once you've collected your dependencies, to build your PB&J:
YOUR ASSEMBLY INSTRUCTIONS HERE

Output

YOUR EXPECTED OUTPUT HERE

What would you expect to read for an Open Source game in order to be able to use it or contribute to it?

Would this be enough?

\$\endgroup\$
5
  • 2
    \$\begingroup\$ The README.md file is specific to GitHub (not open source in general) and is the first thing people get to read when viewing your project. What to put there depends on what you want to communicate to those readers. We can't read your mind, so we can't know what you want to tell these people. \$\endgroup\$
    – Philipp
    Jul 7, 2021 at 8:23
  • \$\begingroup\$ @Philipp while README.md is GitHub-specific, README is common to a lot of opensource projects, including those that were created before git became widespread. \$\endgroup\$
    – Ruslan
    Jul 7, 2021 at 15:05
  • \$\begingroup\$ @Philipp Why should a markdown file be GitHub specific? Any software project since the 80ies comes, more or less with a readme file (or however you want to call it). I know that I can put whatever I want, I am asking for whatever you need to be able to use my project and to contribute in order to make it useful for others. \$\endgroup\$
    – Pitto
    Jul 7, 2021 at 19:16
  • 1
    \$\begingroup\$ @Pitto You asked specifically about a README.md file, not a general README file. But at least I got you to reveal a detail about what you actually want to communicate on your GitHub project file: How to use your project and how to contribute. \$\endgroup\$
    – Philipp
    Jul 7, 2021 at 21:25
  • \$\begingroup\$ @Philipp md is just markdown, it is not a GitHub exclusive. It would be like saying that html is a GitHub exclusive. Markdown perfectly works also on Bitbucket, just to name another and Gitlab and other platforms too. As you can see markdown is perfectly rendered also here in StackExchange (in my post), this once again speaks about its usefulness. Thanks for your contribution! \$\endgroup\$
    – Pitto
    Jul 8, 2021 at 8:22

1 Answer 1

1
\$\begingroup\$

If you share an open source game poeple should be able to build it in their local dev environment. If you add installing and building isntructions and which tools you used will helpful. Also, if you used some private/secrets keys like api key etc. keep them secret don't include them project and indicate people you used this kind of apis/keys.

\$\endgroup\$
1
  • \$\begingroup\$ So basically: clone your repo, follow the instructions, do you have a working game? If not, fix it until this does work. \$\endgroup\$ Jul 8, 2021 at 8:47

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .