https://github.com/aminnairi/collatz
Compute & print the Collatz conjecture.
https://github.com/aminnairi/collatz
c collatz collatz-conjecture makefile
Last synced: 4 days ago
JSON representation
Compute & print the Collatz conjecture.
- Host: GitHub
- URL: https://github.com/aminnairi/collatz
- Owner: aminnairi
- License: mit
- Created: 2020-05-24T10:44:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-26T22:17:19.000Z (about 6 years ago)
- Last Synced: 2025-05-17T15:02:53.194Z (about 1 year ago)
- Topics: c, collatz, collatz-conjecture, makefile
- Language: C
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# collatz
[](https://github.com/aminnairi/collatz/actions?query=workflow%3A%22Compilation+CI%22)
Command line interface to compute & print the [Collatz conjecture](https://en.wikipedia.org/wiki/Collatz_conjecture).
## :book: Requirements
- UNIX-like operating system
- Superuser privileges
- [Git](https://git-scm.com/)
- [GCC](https://gcc.gnu.org/)
- [GNU C Library](https://www.gnu.org/software/libc/)
- [GNU/Make](https://www.gnu.org/software/make/)
- [Man](https://www.gnu.org/prep/standards/html_node/Man-Pages.html#Man-Pages)
## :sparkles: Initialization
```console
$ git clone https://github.com/aminnairi/collatz.git
$ cd collatz
```
## :hammer: Compilation
```console
$ make # for the lazy ones
$ make compile # alternative
```
## :arrow_down: Installation
```console
$ make install
```
> *Note: this will copy the program to the `/usr/local/bin` folder as well as copying the man page to the `/usr/local/man/man1` folder, requiring superuser access.*
## :runner: Run
```console
$ collatz 15
15 46 23 70 35 106 53 160 80 40 20 10 5 16 8 4 2 1
$ collatz 5
5 16 8 4 2 1
```
> *`collatz` only accepts one integer number greater or equal to one.*
## :thinking: Help
```console
$ man collatz
```
## :fire: Uninstallation
```console
$ make uninstall
```
> *Note: this will remove the copy of the program from the `/usr/local/bin` folder as well as removing the man page from the `/usr/local/man/man1` folder, requiring superuser access.*
## :recycle: Clean
```console
$ make clean
```
This will remove the `objects` folder.
## :wastebasket: Hard clean
```console
$ make mrproper
```
This will remove the `objects` & `binaries` folder.
## :question: FAQ
### How can I change the compiler?
```console
$ vim makefile
```
```makefile
COMPILER=gcc
```
### How can I change the compiler's options?
```console
$ vim makefile
```
```console
COMPILER_FLAGS=-Wall -Wextra -Wpedantic -O3 -std=c18
```
### How can I change the linker?
```console
$ vim makefile
```
```makefile
LINKER=gcc
```
### How can I change the linker's flags?
```console
$ vim makefile
```
```makefile
LINKER_FLAGS=
```