diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..075410b --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.vscode/* +.vscode/ +idleterm \ No newline at end of file diff --git a/README.md b/README.md index 5087516..ccb2d2e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # idleterm -Idle terminal screen made for fun (c++) + +I made idleterm to have something similar to [unimatrix](https://github.com/will8211/unimatrix) but made in C++ and a lot simpler, because I wanted an idle terminal screen running on very low-end devices. It currently is only tested on Linux, so feel free to make a windows version and talk to me if you want it to be on the main repo. +## Dependencies + +The libx11-dev headers and libxrandr-dev packages, as well as g++ and libg++ to compile the code. + +Ubuntu: +```bash +sudo apt install libx11-dev libxrandr-dev g++ libg++ +``` +Arch: if you use X11 and have Xrandr installed, the libs should be there. +``` +sudo pacman -Sy gcc xorg-server xorg-xrandr --needed +``` +## Installation + +On any linux distro, just git clone the repo and run the install script (uses sudo to install it on the right folder) + +```bash + git clone https://github.com/augustopereiratx/idleterm + cd idleterm + ./install.sh +``` + +To run it, run `idleterm`. I recommend reading the help prompt by using the `-h` flag. +## Screenshots + +![Program running in Kitty terminal](assets/1.png) +![Program running in Kitty terminal again](assets/2.png) diff --git a/assets/1.png b/assets/1.png new file mode 100644 index 0000000..9fa30f1 Binary files /dev/null and b/assets/1.png differ diff --git a/assets/2.png b/assets/2.png new file mode 100644 index 0000000..be0ac40 Binary files /dev/null and b/assets/2.png differ diff --git a/func.cpp b/func.cpp index c5eb3f1..796b2ef 100644 --- a/func.cpp +++ b/func.cpp @@ -152,4 +152,5 @@ void helpmsg() cout << "OPTIONAL ARGUMENTS\n"; cout << " -c Color: red, green, yellow, blue, magenta [default], cyan, white\n"; cout << " -s Speed: from 1 to 100 [default], in percentage\n"; -} \ No newline at end of file + cout << " -l Character list: e.g. \"!@#$%&*<>()\" [default]"; +} diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..02b9a19 --- /dev/null +++ b/install.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +bash buildlinux.sh +sudo mv idleterm /usr/bin/ +echo "Installation done!" \ No newline at end of file