The CREDITS.md file is designed to recognize and honor the contributions of individuals and organizations that have played a pivotal role in the development and success of a project. It serves as a formal acknowledgment of the efforts of developers, designers, financial supporters, third-party libraries, and any other entities that have provided valuable input or resources. By detailing these contributions in a dedicated CREDITS.md document, projects can transparently attribute the collaborative achievements that have shaped their evolution, fostering a culture of gratitude and open collaboration within the community.
The CREDITS Generator is a straightforward tool designed to help you quickly create a CREDITS.md file for acknowledging contributions to your project. Simply input details of contributors, third-party libraries, financial supporters, and special thanks, then review or edit the preview. Once satisfied, download the CREDITS.md file and place it in the root (or .github folder) of your GitHub repository to transparently showcase all project contributions.
- Built using SvelteKit.
- View a demo of the project on GitHub Pages Here.
Application Preview
I wanted a quick and easy way to generate a CREDITS.md file for my GitHub projects, without having to paste a template over and over again; I couldn't find a generator online, so I built my own!
Feel free to fork and contribute!
- Visit the website, and enter the relevant information.
- Click "Download CREDITS.md File" to your local.
- Place the markdown file in the root (or .github folder) or
docsfolder of your repository.
Note
CREDITS.md is a special file used in GitHub repositories.
It is comparable to AUTHORS, CONTRIBUTORS, and ACKNOWLEDGMENTS files.
It is useful for GNU License Purposes
If you want to download a copy of this application:
- Clone the repo to your local.
- In a terminal, point towards the root of this application.
- Build the application:
npm run build- Run the application:
npm run dev- Visit the website on your localhost, i.e. http://localhost:5173/CREDITS-Generator.
- Follow the instructions above in How this Works to generate your
CREDITS.mdfile.
- Example Credits File # 1 - Example of a
CREDITS.mdfile generated by this application for another project of mine. - Example Credits File # 2 - General example of a
CREDITS.mdfile used for an unaffiliated project. - Basic Markdown Syntax - This generator follows the recommended basic markdown syntax. Read more about it here.
- Svelte - The official Svelte website.
- Node.js - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine (used by Svelte for development).
- Rollup - Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application (used by Svelte for building).
- degit - degit is a scaffolding tool that allows you to clone a git repository without the entire git history (used by Svelte for project creation).
- sirv - sirv is a lightweight server that allows you to serve static files (used by Svelte for development).
- Visual Studio Code - VS Code is a free code editor from Microsoft.
- Svelte for VS Code - Svelte for VS Code is an extension that provides syntax highlighting, code completion, and other features for Svelte.
- SvelteKit - SvelteKit is a framework for building web applications of all sizes, with a beautiful development experience and flexible filesystem-based routing.
- SvelteFire - SvelteFire is a collection of official Svelte bindings for Firebase. It includes bindings for Firebase Authentication, Cloud Firestore, Realtime Database, Storage, and Cloud Messaging. It also includes a collection of utilities for working with Firebase and Svelte.
This project is released under the terms of the MIT License, which permits use, modification, and distribution of the code, subject to the conditions outlined in the license.
- The MIT License provides certain freedoms while preserving rights of attribution to the original creators.
- For more details, see the LICENSE file in this repository. in this repository.
Author: Scott Grivner
Email: [email protected]
Website: scottgrivner.dev
Reference: Main Branch
