Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wolginm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,21 @@ It includes options to automatically batch all the `.heic` files it finds in a f

[Download the latest release](https://github.com/danbrakeley/heic2png/releases), and then put the exe somewhere in your path.

### Compiling on Linux
Copy link
Owner

@danbrakeley danbrakeley Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically these same steps should work on any OS, not just Linux. Maybe title this ### Building from source?


1. Install golang
Copy link
Owner

@danbrakeley danbrakeley Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name of the language is actually just Go, not golang.

- Via apt `apt install golang-go`
Copy link
Owner

@danbrakeley danbrakeley Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apt is distribution specific, and historically has really old versions of languages, so I'd rather not include it here at all.

- Via source [Download and install](https://go.dev/doc/install)
2. Clone this repository `git clone https://github.com/danbrakeley/heic2png.git`
3. Enter the repository and execute the [build.sh](https://github.com/danbrakeley/heic2png/blob/main/build.sh) script
- ```
cd heic2png
chmod +x build.sh
Copy link
Owner

@danbrakeley danbrakeley Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line shouldn't be necessary. Instead of adding this line, you should set the execute bit as part of this PR. I think you can achieve that via git add --chmod=+x build.sh

./build.sh
```
4. Run the script file.
Copy link
Owner

@danbrakeley danbrakeley Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I'm reading this right, I think this step is redundant with step 3?



## Usage

Run `heic2png -h` to see all the flags and arguments. As of v0.2.0, your output should look something like this:
Expand Down