Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
dinkypumpkin committed Jun 8, 2021
1 parent 645c6f6 commit e9f2d73
Showing 1 changed file with 66 additions and 60 deletions.
126 changes: 66 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,66 @@
# AtomicParsley

This is a copy of the [BitBucket repo](https://bitbucket.org/wez/atomicparsley) of this project, because it's more up to date than the [Github repo](https://github.com/wez/atomicparsley) by the same author.

Changes in this version:

* A `.gitignore` file to hide the bits created by autoconf/automake.
* `MAX_ATOMS` has been [bumped from 1024 to 2048](https://github.com/benfry/atomicparsley/commit/a66918b5c76d21f94cdd0f87a9793f729cb4a7e5) to handle some newer files from the iTunes Store.
* Changed `char` to `const char` in a couple places in the macOS-facing code.
* Attempted to use `\uNNNN` escapes because of compiler warnings about `<A9>` and others being illegal characters, but was unsuccessful (came out as ?© in `--longhelp`). Parts of `main.cpp` use octal numbers for © and others, but not gonna fiddle with it further because it appears to be working in spite of the warnings.


## Basic Instructions

If you are building from source you will need autoconf & automake (you will
definitely need make):

% ./autogen.sh
% ./configure
% make

Use the program in situ or place it somewhere in your $PATH by using:

% sudo make install


### Dependencies:

zlib - used to compress ID3 frames & expand already compressed frames
available from http://www.zlib.net

## For Mac OS X users:

To build on Mac OS X / macOS just do a straight forward as shown above.


## For Windows users:
AtomicParsley builds under cygwin and/or mingw using the same procedure as above.

Foosatraz built in Windows 8 using MinGW.

MinGW-get version 0.6.2-beta-20131004-1

mingw-libz version 1.2.8-1 from MinGW Installation Manager

% ./autogen.sh
% ./configure --prefix=/mingw
% make LDFLAGS=-static
% strip AtomicParsley.exe

Full details [pdf](https://bitbucket.org/Foosatraz/wez-atomicparsley-foosatraz-fork/downloads/AtomicParsleyMinGWBuildNotebook.pdf)

To build with MSVC, you will need to create your own project file; look
at the list of source files in Makefile.am; you need to add all of the
source files *except* the .mm files. You will also need to provide your
own zlib.

If you don't want to build it yourself, [Jon Hedgrows' fork ](https://bitbucket.org/jonhedgerows/atomicparsley/wiki/Home) maintains pre-built Windows binaries of the Wez fork:
[Windows Downloads](https://bitbucket.org/jonhedgerows/atomicparsley/downloads)

# AtomicParsley (get_iplayer version)

## Linux

* Tools: gcc/g++, make, autoconf, automake, git

* Dependencies: requires **zlib** development headers and libraries, which may be installed separately from the runtime library

# Debian/Ubuntu example - adjust for other distros
# install compilers, utilities, zlib development support
sudo apt install build-essential make autoconf automake git zlib1g-dev
# download source code
git clone https://github.com/get-iplayer/atomicparsley.git
cd atomicparsley
# build
./autogen.sh
./configure
make
# install in $PATH
sudo make install

## macOS

* Install [Homebrew](https://brew.sh)

* Xcode command-line tools are installed with Homebrew

# install additional utilities
brew install autoconf automake
# download source code
git clone https://github.com/get-iplayer/atomicparsley.git
cd atomicparsley
# build
./autogen.sh
./configure
make
# install in $PATH
sudo make install

## Windows

* Install [MSYS2 (64-bit)](https://www.msys2.org/wiki/MSYS2-installation/)

* 32-bit: Open "MSYS2 MinGW 32-bit" command prompt from Start Menu

# install 32-bit toolchain
pacman -S mingw-w64-i686-gcc
- 64-bit: Open "MSYS2 MinGW 64-bit" command prompt from Start Menu

# install 64-bit toolchain
pacman -S mingw-w64-x86_64-gcc

- 32-bit and 64-bit: Complete build

# install additional utilities
pacman -S make autoconf automake-wrapper git
# retrieve source code
git clone https://github.com/get-iplayer/atomicparsley.git
cd atomicparsley
# build
./autogen.sh
./configure
make LDFLAGS=-static
# copy AtomicParsley.exe to desired location


0 comments on commit e9f2d73

Please sign in to comment.