diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3cdde1 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# ImageGoNord client + +ImageGoNord is a tool that can convert your rgb images to nordtheme palette. + +You can find more information here: [ImageGoNord](https://github.com/Schrodinger-Hat/ImageGoNord) + +This repository is a client, written in python, that can convert any sort of image into a nordtheme palette image. + +## Getting Started +Include any essential instructions for: + +- Getting it: + ``` + git clone https://github.com/Schrodinger-Hat/ImageGoNord-cli + ``` + +- Install dependencies + ``` + pip install -r requirements.txt + ``` +- Running it + ``` + python src/cli.py --img='' + ``` + +The algorithm can take some time (we are working on improving it), you can find the result with the name *nord.png*. + +You can define some more configuration and use different palettes, find more using: + +``` +python src/cli.py --help +``` + +### Contributing +- Follow the contributor guidelines +- Follow the code style / requirements +- Format for commit messages + + +# Authors +[TheJoin95](https://github.com/TheJoin95) & [Wabri](https://github.com/Wabri) + +**NOTE**: we are not (yet) affiliated with the Nordtheme or [Arcticicestudio](https://github.com/arcticicestudio). + +# Credits + +[Nordtheme](https://www.nordtheme.com/)