From 9210cc296fd56bd14bc97a59f70cea263d5f6afd Mon Sep 17 00:00:00 2001 From: Guaxinim Date: Sat, 11 Jun 2022 19:06:14 -0300 Subject: [PATCH] Create README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..278ed50 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# what-to-code-cli +Get a random idea from https://what-to-code.com/ +![preview.png](https://i.imgur.com/AoDhkDJ.png) + +## Installation +### From source +``` +git clone https://github.com/Guaxinim5573/what-to-code-cli +cd what-to-code-cli +sudo make +``` +##### Avaible make targets +``` +make build # Builds with --release +make build-debug # Builds without --release +make install # Installs what-to-code (needs root permissions) +make uninstall # Uninstall what-to-code (needs root permissions) +``` +# License +This program uses [LGPL v3.0](https://github.com/Guaxinim5573/what-to-code-cli/blob/main/LICENSE) license.