Skip to content

Commit 554e630

Browse files
committed
added readme
1 parent 9d136b8 commit 554e630

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# filter-go
2+
3+
This is my first attempt at writing [Go](https://go.dev/).
4+
5+
When I set out to learn this language, I wanted to build something simple, fun and challenging:
6+
7+
This [this problem set](https://cs50.harvard.edu/x/2022/psets/4/filter/more/) felt like a worthwhile challenge because it had just the right amount of complexity paired with the playfulness of manipulating bytes, sometimes leading to unexpected and interesting glitches:
8+
9+
**Calculation errors when reversing the image**
10+
11+
![glitch-02](/assets/glitches/glitch-02.bmp)
12+
13+
**Calculation errors when computing averages**
14+
15+
![glitch-01](/assets/glitches/glitch-01.bmp)
16+
17+
# About
18+
This is a command line application that allows the user to input a BMP image and apply a transformation to it. The program then outputs the result.
19+
20+
The app can perform the following transformations:
21+
* Convert the image to grayscale
22+
* Reflect the image horizontally
23+
* Blur the image
24+
25+
# Requirements
26+
You need Go to run this app. You can find instructions on how to install it [here](https://go.dev/doc/install)
27+
28+
# Usage
29+
From the root of the project you can run
30+
31+
`$ go build && ./filter-go [flag] <infile>.bmp <outfile>.bmp`
32+
33+
To try out the app use the sample BMP files stored in the `/assets` folder. Resulting files will be written to the `/out` folder.
34+
35+
## Flags
36+
37+
```sh
38+
-b Blur image
39+
-g Make image grayscale
40+
-r Reflect image horizontally
41+
```
42+
43+
# Thanks
44+
45+
All the [Discord Gophers](https://discord.com/channels/118456055842734083/118456055842734083) that took the time to answer my questions <3

assets/glitches/glitch-01.bmp

703 KB
Binary file not shown.

assets/glitches/glitch-02.bmp

2.06 MB
Binary file not shown.

0 commit comments

Comments
 (0)