diff --git a/README.md b/README.md index a2df495..cf53755 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# What is this +# YAITAA - Yet Another Image To A(NSI) Art (converter). -YAITAA - Yet Another Image To A(NSI) Art (converter). +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9fdbd9f8bc7843df9a6715b72b4da2fd)](https://www.codacy.com/gh/hatkidchan/yaitaa/dashboard?utm_source=github.com&utm_medium=referral&utm_content=hatkidchan/yaitaa&utm_campaign=Badge_Grade) Yes, very original. Old name is `asciify-reborn` for reasons stated bellow -# Reasons for reimplementation +## Reasons for reimplementation Everything is already described in [hatkidchan/asciify](https://github.com/hatkidchan/asciify#readme), but just as @@ -18,9 +18,8 @@ recap: 6. Git submodules. Yay. -# Build instructions - -## 1. Make sure that you have C compiler and make +## Build instructions +### 1. Make sure that you have C compiler and make ```sh cc --version && make --version && echo 'ok' @@ -28,28 +27,28 @@ cc --version && make --version && echo 'ok' Both of commands should succeed. -## 2. Clone repo: +### 2. Clone repo ```sh git clone --recursive https://github.com/hatkidchan/yaitaa cd yaitaa ``` -## 2. Build it +### 2. Build it ```sh make ``` -## 3. Run it +### 3. Run it ```sh ./yaitaa -M braille -S 256 -W 80 -H 24 ~/images/kitty.png ``` -## Build end notes +### Build end notes -### 1. It is preferred to use `clang` as your compiler +#### 1. It is preferred to use `clang` as your compiler Main reason being that it is more strict, so any issues I've missed may be reported on that step. Feel free to send them to me! @@ -58,13 +57,13 @@ reported on that step. Feel free to send them to me! CC=clang make ``` -### 2. Strip binary to reduce size (saves ~100KiB) +#### 2. Strip binary to reduce size (saves ~100KiB) ```sh strip ./yaitaa ``` -### 3. Installation +#### 3. Installation It's not really designed to be installed system-wide, but if you *really* want to do so, do the following @@ -81,9 +80,9 @@ Alternatively, you can install it to your local directory, if it's in your cp ./yaitaa ~/.local/bin/yaitaa ``` -# License +## License -``` +```text yaitaa - Yet Another Image To A(NSI) Art (converter) Copyright (C) 2022 hatkidchan