Skip to content

Commit e7640e5

Browse files
committed
Update readme
1 parent b0d6223 commit e7640e5

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,40 @@
33
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/wez/atomicparsley/CI)
44
![Maintenance](https://img.shields.io/maintenance/no/2012)
55

6-
**Maintenance Note:** This repo is not actively maintained by @wez.
6+
## Installation
77

8-
A note from @wez:
8+
### macOS
99

10-
> I made some fixes in 2009 and became the de-facto fork of AtomicParsley as a
10+
* Navigate to the [latest release](https://github.com/wez/atomicparsley/releases/latest)
11+
* Download the `AtomicParsleyMacOS.zip` file and extract `AtomicParsley`
12+
13+
### Windows
14+
15+
* Navigate to the [latest release](https://github.com/wez/atomicparsley/releases/latest)
16+
* Download the `AtomicParsleyWindows.zip` file and extract `AtomicParsley.exe`
17+
18+
### Building from Source
19+
20+
If you are building from source you will need `cmake` and `make`.
21+
On Windows systems you'll need Visual Studio or MingW.
22+
23+
```
24+
cmake .
25+
cmake --build .
26+
```
27+
28+
will generate an `AtomicParsley` executable.
29+
30+
### Dependencies:
31+
32+
zlib - used to compress ID3 frames & expand already compressed frames
33+
available from http://www.zlib.net
34+
35+
36+
## A note on maintenance!
37+
38+
> I made some fixes to the original project on sourceforge back in
39+
> in 2009 and became the de-facto fork of AtomicParsley as a
1140
> result. However, I haven't used this tool myself in many years and have
1241
> acted in a very loose guiding role since then.
1342
>
@@ -26,20 +55,3 @@ A note from @wez:
2655
> You are welcome to report issues using the issue tracker, but I am
2756
> unlikely to act upon them.
2857
29-
## Basic Instructions
30-
31-
If you are building from source you will need `cmake` and `make`.
32-
On Windows systems you'll need Visual Studio or MingW.
33-
34-
```
35-
cmake .
36-
cmake --build .
37-
```
38-
39-
will generate an `AtomicParsley` executable.
40-
41-
### Dependencies:
42-
43-
zlib - used to compress ID3 frames & expand already compressed frames
44-
available from http://www.zlib.net
45-

0 commit comments

Comments
 (0)