arkorty/donut.c
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arkaprabha Chakraborty
2022-02-11 17:34:42 +05:30
parent 4f5526a474
commit 593179ab33
1 changed files with 42 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -1,26 +1,59 @@
# Description
Prints a spinning ASCII torus (mathematical name for a doughnut-shaped object) on the terminal. Original post by Andy Sloane can be found [here](https://www.a1k0n.net/2011/07/20/donut-math.html).
# Updates
* Now supports dynamic resolution based on terminal size
# How to run
* Clone or download and extract the repository
* Open a terminal inside the project directory
* Follow the steps for your Operating System
# For Windows
## Prerequisites for Windows 10 or Windows 11
* Install a compiler like [GCC](https://gcc.gnu.org/) or [Clang](https://clang.llvm.org/) for the C version
* Install [Python](https://www.python.org/) for the Python version
## How to run the Python version
* Type `python main.py` in the shell to run the Python version
## How to compile the C version
* Type `gcc -o main.exe main.c -lm` in the shell to compile using GCC
* Type `clang -o main.exe main.c -lm` in the shell to compile using Clang
## How to run the C version
* Run `.\main.exe` in the shell to run the program
# For Linux
## Prerequisites for Debian based distros
* `sudo apt install make` to install Make
* `make deb` to install the required compilers
## Prerequisites for Arch based distros
* `sudo pacman -S make` to install Make
* `make arch` to install the required compilers
## How to run?
* Clone or download the repository
* Open a terminal inside the project directory
* Complete the prerequisites for your OS
## How to run the programs
* `make c` to run the C version
* `make py` to run the Python version
## How to clean up the executable?
* `make clean` to delete the executable
## How to clean up the executable
* `make clean` to clean after execution
# Updates
* Added support for dynamic resolution based on current terminal size
* Added Windows support
# Screenshot
![screenshot.png](https://github.com/arkorty/Spinning-ASCII-Torus/blob/main/blob/screenshot.png)
![Screenshot](https://github.com/arkorty/Spinning-ASCII-Torus/blob/main/blob/screenshot.png)