Skip to content

Commit

Permalink
Merge pull request #2 from brhaka/development
Browse files Browse the repository at this point in the history
V 1.1.1
  • Loading branch information
brhaka authored Apr 10, 2021
2 parents 5244b9b + d60f1a4 commit 9c1a44c
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 18 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: brhaka

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Input '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. Ubuntu 20.04]
- Version [e.g. 1.1]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: brhaka

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
*.swp
*.swo
.vscode
main
a.out
image_to_ascii
ImageToASCII
ImageToASCII.exe
ImageToASCII_NoColors
ImageToASCII_NoColors.exe
path.brk
ascii.brk
*.jpg
Expand Down
27 changes: 19 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,21 +1,32 @@
# ******************************** #
# Author: Brhaka #
# #
# #
# github.com/brhaka/ImageToASCII #
# ******************************** #

SRCS := ./image_to_ascii.c
NAME := ImageToASCII
USE_COLORS = 1

all: UNIX WIN
all: LINUX MACOS WIN

$(NAME): LINUX MACOS WIN

$(NAME): UNIX WIN
LINUX:
gcc $(SRCS) -static -lm -D USE_COLORS=$(USE_COLORS) -o $(NAME)-Linux

UNIX:
gcc $(SRCS) -static -lm -D USE_COLORS=$(USE_COLORS) -o $(NAME)
MACOS:
gcc $(SRCS) -lm -D USE_COLORS=$(USE_COLORS) -o $(NAME)-MacOS

WIN:
i686-w64-mingw32-g++ $(SRCS) --static -D USE_COLORS=$(USE_COLORS) -o $(NAME)
i686-w64-mingw32-g++ $(SRCS) --static -D USE_COLORS=$(USE_COLORS) -o $(NAME)-Windows_x86_x64

clean:
rm -f $(NAME)
rm -f $(NAME).exe
rm -f $(NAME)-Linux
rm -f $(NAME)-MacOS
rm -f $(NAME)-Windows_x86_x64.exe

re: clean $(NAME)

.PHONY: re clean WIN UNIX all
.PHONY: re clean WIN MACOS LINUX all
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Since the program has no control over which font the ASCII art is being visualiz

## Installation

ImageToASCII is compiled to a single file, for easier use. If you want to run it on an **UNIX** Operating System, like **Linux** and **MacOS**, you should download the `ImageToASCII` file. In case you want to run it on **Windows** x64 or x86, download the `ImageToASCII.exe` file. You can start your download at the [Releases](https://github.com/brhaka/ImageToASCII/releases) section.
ImageToASCII is compiled to a single file, for easier use. There is a specific file for each OS version. If you wish to use ImageToASCII on **Linux**, download the `ImageToASCII-Linux` file. On **MacOS**, download the `ImageToASCII-MacOS` file and on **Windows**, download the `ImageToASCII-Windows_x86_x64.exe` file. You can start your download at the [Releases](https://github.com/brhaka/ImageToASCII/releases) section. It's also possible to [compile the source code](https://github.com/brhaka/ImageToASCII#compiling).

To start the program, all you need to do is execute it via command-line: (`./ImageToASCII "./image.png"`) or (`./ImageToASCII.exe "./image.png"`).
To start the program, all you need to do is execute it via command-line. E.g: `./ImageToASCII-Linux "./image.png"`

### Branches

Expand All @@ -35,11 +35,11 @@ The **[master](https://github.com/brhaka/ImageToASCII/tree/master)** branch cont

It's also possible to download the source code and compile it yourself. First, you must clone or fork this repository into an empty directory. Then, via command-line, you can run the following commands:

`make UNIX` will compile the **UNIX** version of the program. The output file is named `ImageToASCII`. This command uses `gcc`.
`make LINUX` and `make MACOS` will compile the **Linux** and **MacOS** versions of the program. The output files are named `ImageToASCII-Linux` and `ImageToASCII-MacOS`, respectively. This command uses `gcc`. In order to execute it on Linux, it must be compiled on **Linux** and the same rule is applied to **MacOS**.

`make WIN` will compile the **Windows** (x64 and x86) version of the program. The output file is named `ImageToASCII.exe`. This command uses **mingw**.
`make WIN` will compile the **Windows** (x86 and x64) version of the program. The output file is named `ImageToASCII-Windows_x86_x64.exe`. This command uses **mingw**.

The `make`, `make all`, `make re` and `make ImageToASCII` commands will compile both **UNIX** and **Windows** versions of the program.
The `make`, `make all`, `make re` and `make ImageToASCII` commands will compile the **Linux**, **MacOS** and **Windows** versions of the program.

To compile a version that won't use ANSI colors on the output, add `USE_COLORS=0` to your `make *` command. E.g: `make WIN USE_COLORS=0`

Expand All @@ -48,16 +48,23 @@ To compile a version that won't use ANSI colors on the output, add `USE_COLORS=0
* Supports JPG, JPEG, PNG, TGA, BMP, PSD, HDR, PIC
* Works with **any** image resolution
* Clean and detailed ASCII arts
* **UNIX** and **Windows** versions
* **Linux**, **MacOS** and **Windows** versions
* Lightweight
* Open Source

## Showcase

![Beliaikin](https://user-images.githubusercontent.com/32342284/113486110-00477900-94a9-11eb-82f8-b0927eb04f75.jpg)
![Antelope Close-Up](https://user-images.githubusercontent.com/32342284/113486115-03426980-94a9-11eb-9d07-807445e3e608.jpg)
![Leitisvatn](https://user-images.githubusercontent.com/32342284/113486120-05a4c380-94a9-11eb-8edd-a9513ed0a3c4.jpg)
![Girl Holding Leaf](https://user-images.githubusercontent.com/32342284/113486484-06d6f000-94ab-11eb-9cda-6aa50a31dc41.jpg)
### High character count

![Beliaikin](https://user-images.githubusercontent.com/32342284/114232473-d7752700-9973-11eb-9889-dc30f1bb69d8.jpg)
![Antelope Close-Up](https://user-images.githubusercontent.com/32342284/114233077-b2cd7f00-9974-11eb-932e-b95f23102268.jpg)
![Leitisvatn](https://user-images.githubusercontent.com/32342284/114232421-c5938400-9973-11eb-8f8b-ac16a543ade0.jpg)
![Girl Holding Leaf](https://user-images.githubusercontent.com/32342284/114232397-b90f2b80-9973-11eb-9958-1dd4f8296875.jpg)

### Low character count

![Pear Low](https://user-images.githubusercontent.com/32342284/114232801-5d916d80-9974-11eb-88f5-a94218a8a622.jpg)
![Antelope Close-Up Low](https://user-images.githubusercontent.com/32342284/114232569-f673b900-9973-11eb-874c-675369ebe6ea.jpg)

*Images by [pexels.com](https://www.pexels.com/collections/imagetoascii-vk9vgay/) and [Eirik Sørstrømmen](https://500px.com/photo/122484453/the-cliffs-of-leitisvatn-by-eirik-sorstrommen)*

Expand Down

0 comments on commit 9c1a44c

Please sign in to comment.