Watch the introduction video on YouTube.
This all started with donut.c, the classic C code that looks like, and generates a 3D spinning donut when run. Out of sheer curiosity, I searched up this code in different languages, and noticed that many people have created 3D spinning donuts in those languages... but their code mostly didn't look like a donut.
My goal at the start was to bring this classic piece of code (and its donut shape) to different languages. I started with a JavaScript rendition of donut.c. Then, after much struggle, I created a Python version.
Because I thought it would be fun, I posted both of these projects on YouTube, and to my surprise, it caught on quickly, getting around 90k views in 2 weeks—and counting. People started asking me to make this in different languages. And now I'm asking you.
The Donut Project seeks to replicate donut.c in as many languages as possible, and it's really quite easy to join...
You can either...
Do so in 2 easy steps:
First, find a language that someone hasn't done yet (you can see the finished languages in the donuts folder or info.json) and recreate donut.c!
If you would like to contribute a donut in a language someone has already done with your own spin to it, write the file like this: donut.[TYPE].[EXTENSION] with a JSON key in info.json of [TYPE].[EXTENSION]. For example, if you were to make a JS donut only using fixed-point arithmetic (so-called being "pure"), you may call it donut.pure.js with a JSON key of pure.js. Ensure you place in the PR why you believe this donut is unique enough to be its own separate file.
Additionally, please include a short summary in the description of why this donut is special.
- Make sure that the output is similar to the original donut.c.
- Also, importantly, make sure that the code looks like a donut. To make this easier you can use
donutGenerator.
Additionally, here are some (decently strong) recommendations about how you should make your donut:
- Make sure the donut is mostly code. It's alright if there are a few lines/places with comments, however.
Now, fork this repo with the following command.
git clone https://github.com/EvanZhouDev/TheDonutProject.gitAdd your donut to the donuts folder. Ensure it is named donut, with the proper extension at the end. For example, I may have the file donut.py, donut.js, or donut.pure.js (as mentioned above).
Then, add an entry into info.json. The key should be whatever file extension (and potentially additional suffixes) you are using (make sure it matches with your file—it should be everything that follows donut.), and the value should look like this:
| Key | Description | Required? |
|---|---|---|
name |
Your name, or name you would like to associate your donut with | Required |
github |
Your GitHub account | Optional |
repo |
Full link to your GitHub repository where you have your donut | Optional |
run |
Command to run your donut with; refer to the file simply as donut.* |
Required if special action needed (i.e. compiler flags, etc.) |
description |
Describe your donut. | Required for alternate-implementation donuts. |
For example, my donut.js would look something like this:
Please use 4 space indentation in
info.json.
"js": {
"name": "Evan Zhou",
"github": "EvanZhouDev",
"repo": "https://github.com/EvanZhouDev/donut-js"
}Finally, simply submit a PR (with the language you are contributing in the title), and go through the checklist to complete your submission.
Alternatively, you can also submit donuts that you have found floating around the community already. Ensure that it still follows the basic rules and recommendations.
Submit it just the same as above, but make sure you put their name and their GitHub and repo if applicable in the info.json.
Thank you to @Rudxain for the suggestion.