{"author_link":"\/users\/dhim","author_name":"dhim","author_uid":"dhim","comments":[],"epoch":1743673932,"event":"LD57","format":"md","ldjam_node_id":409131,"likes":15,"metadata":{"p_key":"209686","p_author":"dhim","p_authorkey":"1015212","p_urlkey":"448569","p_title":"Preparing Your GitHub Repository for Ludum Dare 57","p_cat":"LDJam ","p_event":"LD57","p_time":"1743673932","p_likes":"15","p_comments":"0","p_status":"WAYBACK","us_key":"1015212","us_name":"dhim","us_username":"dhim","event_start":"1743811200","event_key":"111","event_name":"Ludum Dare 57"},"node":{"_collation":{"body_sanitizer":"TextUtils::SanitizeHTML via existing importer","event":"LD57","removed_author":false},"_superparent":406845,"_trust":3,"author":15212,"body":"I am excited for Ludum Dare 57, I had no time to prepare though until now. For the previous edition I had made an effort to clean my github repositories, have a clean and uniform readme across the several editions I participated. I try to put all the information I have gathered in order to help the community (disclaimer an LLM \nhelped me clean the english for the rest of that post) \n\n![Screen Shot 2025-04-03 at 11.51.40.png](\/\/\/raw\/c6b\/3\/z\/69568.png)\n\nMy goal is to have a repository that people are keen to visit to look at my code, share, star, or fork it to elaborate on. I also try to do the same while reviewing other compo game to look at their repo, add a star to my personal collection of game I have played\n\n\n### 1. Repository Setup\nStart by creating a repository on GitHub. I first name the repository LD57, I'll update the name later on when I am finishing the project. Github keeps the links active. (you can reach my previous entry by both of the links : \n\n\n```\nhttps:\/\/github.com\/dhmmasson\/lilyFrogs\nhttps:\/\/github.com\/dhmmasson\/LD56 \n```\n\nI like to update the name afterward because it makes it easier to identify in list (see : https:\/\/github.com\/topics\/ludumdare56). Add a short but description that explain in very few word what's the game is about (on the top right of the main page in the *about* section) \n\n> 56 Lilypads is a turn-based game where frogs leap between lilypads to catch flies and lotuses, but each lilypad disappears once left behind! Compete for the highest score in this strategic battle before movement options run out\n\nConsider using these **topics** to make your Ludum Dare entry more discoverable:\n- `game`\n- `game-development`\n- `ludum-dare`\n- `ludumdare`\n- `ludumdare57`\n- `ludum-dare-57`\n- `ld57`\n\nIn the repository setting you can also add a cover image, that github will display in list and while sharing the repository on social media. \n\n\n### 2. README.md: First Impressions Matter\nA well-structured `README.md` file is crucial. It should include:\n- A brief introduction to your game\n- Screenshots or GIFs (if possible)\n- Installation and running instructions\n- A link to your Ludum Dare submission page\n- Credits and acknowledgments\n\n### 3. Use Badges for cool look\nBadges help make your repository visually appealing and informative at a glance. \n\nUsing shields.io I have created some shield for ludumdare, one for the edition and two for the compo\/jam using the ludum dare color palette. \n\n```md\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare-57-f79122?labelColor=ee5533&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57)\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare57-Compo-f79122?labelColor=6f7984&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57%2Fgames%2Foverall%2Fcompo)\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare57-Jam-ee5533?labelColor=6f7984&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57%2Fgames%2Foverall%2Fjam)\n```\n![Screen Shot 2025-04-03 at 11.50.02.png](\/\/\/raw\/c6b\/3\/z\/69567.png)\n\nYou can also use badges for what stack you use, what platform you support, the license used...\n```md\n![HTML5](https:\/\/img.shields.io\/badge\/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)\n[![License: MIT](https:\/\/img.shields.io\/badge\/License-MIT-yellow.svg)](https:\/\/opensource.org\/licenses\/MIT)\n```\nOnce the event is over, you can use this excellent website https:\/\/badges.jaxs.onl\/ a rating badge like this:\n```md\n![Ratings](https:\/\/badges.jaxs.onl\/56\/fifty-six-frogs\/badge.svg)\n```\n\n### 4. Choose a License\nAdding a license is essential if you want others to use or contribute to your code. Popular choices include:\n- **MIT**: Permissive, widely used\n- **GPL**: Requires derivative works to also be open-source\n\nUse [choosealicense.com](https:\/\/choosealicense.com\/) to help pick the right one.\n\n### 5. Add a `CITATION.cff` File \n\nIf you are an academic and you\u2019d like others to properly cite your work, include a `CITATION.cff` file. Example:\n```yaml\ncff-version: 1.2.0\ntitle: Fifty Six Lilypads!\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors:\n  - given-names: Dimitri\n    family-names: Masson\n    orcid: 'https:\/\/orcid.org\/0000-0002-7072-3146'\n    email: ...\nrepository-code: 'https:\/\/github.com\/dhmmasson\/LD56'\nurl: 'https:\/\/dhmmasson.github.io\/lilyFrogs'\nlicense: MIT\nversion: v1.0.0\ndate-released: '2024-10-06'\n```\n\n### 6. Engage with the Community\nLudum Dare is not just about making games but also about interacting with fellow developers. Here are some ways to engage:\n- **Star and watch** other participants' repositories\n- **Give and request feedback** on GitHub Discussions\n- **Fork** the games you like to try your spin on it\n- **Use Issues and Pull Requests** to track progress\n\n### 7. Share Your Repository\nOnce your repo is ready, share it on social media, the Ludum Dare website, and relevant forums. Encourage others to star and fork your project!\n\n---\n\nAre you using GitHub for Ludum Dare 57? \nWhat best practices do you follow? \nShare your thoughts below!\n\n","comments":0,"created":"2025-04-02T15:40:48Z","files":[],"files-timestamp":0,"id":409131,"love":15,"love-timestamp":"2025-04-21T02:07:29Z","meta":[],"modified":"2025-04-21T02:07:29Z","name":"Preparing Your GitHub Repository for Ludum Dare 57","node-timestamp":"2025-04-03T09:52:12Z","parent":407594,"parents":[1,5,9,406845,407594],"path":"\/events\/ludum-dare\/57\/focus-hunt\/preparing-your-github-repository-for-ludum-dare-57","published":"2025-04-03T09:52:12Z","scope":"public","slug":"preparing-your-github-repository-for-ludum-dare-57","subsubtype":"","subtype":"","type":"post","version":1283770},"node_metadata":{"n_key":"409131","n_urlkey":"448569","n_parent":"407594","n_path":"\/events\/ludum-dare\/57\/focus-hunt\/preparing-your-github-repository-for-ludum-dare-57","n_slug":"preparing-your-github-repository","n_type":"post","n_subtype":"","n_subsubtype":"","n_author":"15212","n_created":"1743608448","n_modified":"1745201249","n_version":"1283770","n_status":"WAYBACK"},"source_url":"https:\/\/ldjam.com\/events\/ludum-dare\/57\/focus-hunt\/preparing-your-github-repository-for-ludum-dare-57","text":"I am excited for Ludum Dare 57, I had no time to prepare though until now. For the previous edition I had made an effort to clean my github repositories, have a clean and uniform readme across the several editions I participated. I try to put all the information I have gathered in order to help the community (disclaimer an LLM \nhelped me clean the english for the rest of that post) \n\n![Screen Shot 2025-04-03 at 11.51.40.png](\/\/\/raw\/c6b\/3\/z\/69568.png)\n\nMy goal is to have a repository that people are keen to visit to look at my code, share, star, or fork it to elaborate on. I also try to do the same while reviewing other compo game to look at their repo, add a star to my personal collection of game I have played\n\n\n### 1. Repository Setup\nStart by creating a repository on GitHub. I first name the repository LD57, I'll update the name later on when I am finishing the project. Github keeps the links active. (you can reach my previous entry by both of the links : \n\n\n```\nhttps:\/\/github.com\/dhmmasson\/lilyFrogs\nhttps:\/\/github.com\/dhmmasson\/LD56 \n```\n\nI like to update the name afterward because it makes it easier to identify in list (see : https:\/\/github.com\/topics\/ludumdare56). Add a short but description that explain in very few word what's the game is about (on the top right of the main page in the *about* section) \n\n> 56 Lilypads is a turn-based game where frogs leap between lilypads to catch flies and lotuses, but each lilypad disappears once left behind! Compete for the highest score in this strategic battle before movement options run out\n\nConsider using these **topics** to make your Ludum Dare entry more discoverable:\n- `game`\n- `game-development`\n- `ludum-dare`\n- `ludumdare`\n- `ludumdare57`\n- `ludum-dare-57`\n- `ld57`\n\nIn the repository setting you can also add a cover image, that github will display in list and while sharing the repository on social media. \n\n\n### 2. README.md: First Impressions Matter\nA well-structured `README.md` file is crucial. It should include:\n- A brief introduction to your game\n- Screenshots or GIFs (if possible)\n- Installation and running instructions\n- A link to your Ludum Dare submission page\n- Credits and acknowledgments\n\n### 3. Use Badges for cool look\nBadges help make your repository visually appealing and informative at a glance. \n\nUsing shields.io I have created some shield for ludumdare, one for the edition and two for the compo\/jam using the ludum dare color palette. \n\n```md\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare-57-f79122?labelColor=ee5533&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57)\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare57-Compo-f79122?labelColor=6f7984&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57%2Fgames%2Foverall%2Fcompo)\n![Ludum Dare](https:\/\/img.shields.io\/badge\/LudumDare57-Jam-ee5533?labelColor=6f7984&link=https%3A%2F%2Fldjam.com%2Fevents%2Fludum-dare%2F57%2Fgames%2Foverall%2Fjam)\n```\n![Screen Shot 2025-04-03 at 11.50.02.png](\/\/\/raw\/c6b\/3\/z\/69567.png)\n\nYou can also use badges for what stack you use, what platform you support, the license used...\n```md\n![HTML5](https:\/\/img.shields.io\/badge\/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)\n[![License: MIT](https:\/\/img.shields.io\/badge\/License-MIT-yellow.svg)](https:\/\/opensource.org\/licenses\/MIT)\n```\nOnce the event is over, you can use this excellent website https:\/\/badges.jaxs.onl\/ a rating badge like this:\n```md\n![Ratings](https:\/\/badges.jaxs.onl\/56\/fifty-six-frogs\/badge.svg)\n```\n\n### 4. Choose a License\nAdding a license is essential if you want others to use or contribute to your code. Popular choices include:\n- **MIT**: Permissive, widely used\n- **GPL**: Requires derivative works to also be open-source\n\nUse [choosealicense.com](https:\/\/choosealicense.com\/) to help pick the right one.\n\n### 5. Add a `CITATION.cff` File \n\nIf you are an academic and you\u2019d like others to properly cite your work, include a `CITATION.cff` file. Example:\n```yaml\ncff-version: 1.2.0\ntitle: Fifty Six Lilypads!\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors:\n  - given-names: Dimitri\n    family-names: Masson\n    orcid: 'https:\/\/orcid.org\/0000-0002-7072-3146'\n    email: ...\nrepository-code: 'https:\/\/github.com\/dhmmasson\/LD56'\nurl: 'https:\/\/dhmmasson.github.io\/lilyFrogs'\nlicense: MIT\nversion: v1.0.0\ndate-released: '2024-10-06'\n```\n\n### 6. Engage with the Community\nLudum Dare is not just about making games but also about interacting with fellow developers. Here are some ways to engage:\n- **Star and watch** other participants' repositories\n- **Give and request feedback** on GitHub Discussions\n- **Fork** the games you like to try your spin on it\n- **Use Issues and Pull Requests** to track progress\n\n### 7. Share Your Repository\nOnce your repo is ready, share it on social media, the Ludum Dare website, and relevant forums. Encourage others to star and fork your project!\n\n---\n\nAre you using GitHub for Ludum Dare 57? \nWhat best practices do you follow? \nShare your thoughts below!\n\n","title":"Preparing Your GitHub Repository for Ludum Dare 57","wayback_source":[]}