~scottydelicious666/brewtarget/brewtarget : contents of README.markdown at revision 798

~scottydelicious666/brewtarget/brewtarget : (revision 798)

# Brewtarget

Brewtarget is free open-source brewing software, and a beer recipe creation
tool available for Linux, Mac, and Windows. It automatically calculates color,
bitterness, and other parameters for you while you drag and drop ingredients
into the recipe. Brewtarget also has many other tools such as priming sugar
calculators, OG correction help, and a unique mash designing tool. It also can
export and import recipes in BeerXML, allowing you to easily share recipes with
friends who use BeerSmith or other programs. All of this means that Brewtarget
is your single, free, go-to tool when crafting your beer recipes.

## Authors

* Philip G. Lee <rocketman768@gmail.com> - Lead developer
* Mik Firestone <mikfire@gmail.com>
* Maxime Lavigne <duguigne@gmail.com>
* Dan Cavanagh <dan@dancavanagh.com>
* Rob Taylor <robtaylor@floopily.org>
* Kregg K <gigatropolis@yahoo.com>
* A.J. Drobnich <aj.drobnich@gmail.com>
* Ted Wright <tedwright@users.sourceforge.net>
* Charles Fourneau (plut0nium) <charles.fourneau@gmail.com>
* Maxime Lavigne (malavv) <duguigne@gmail.com>
* Peter Buelow <goballstate@gmail.com>
* David Grundberg <individ@acc.umu.se>
* Tim Payne <swstim@gmail.com>
* Samuel Östling <MrOstling@gmail.com>
* Luke Vincent <luke.r.vincent@gmail.com>
* Eric Tamme <etamme@gmail.com>
* Julein <j2bweb@gmail.com>
* Jeff Bailey <skydvr38@verizon.net>
* Piotr Przybyla (przybysh) <przybysh@gmail.com>
* Chris Hamilton <marker5a@gmail.com>

Author list created with:

    $ git log --raw | grep "^Author: " | sort | uniq -c | sort -nr

## Websites

* [Main website](http://www.brewtarget.org)
* [Google group](https://groups.google.com/forum/?fromgroups=#!forum/brewtarget-help)
* [Source code repository](http://www.gitorious.org/brewtarget)
* [Project development page](https://launchpad.net/brewtarget)
* [Bug tracker](https://bugs.launchpad.net/brewtarget)
* [Developers team](https://launchpad.net/~brewtarget-devs)
* [Developers Wiki](https://gitorious.org/brewtarget/pages/Home)

## Compiling and Installing

### Dependencies

Most of these can be satisfied by installing qt and a compiler.

* libc6 (>= 2.14)
* libgcc1 (>= 1:4.1.1)
* libphonon4 (>= 4:4.2.0)
* libqt4-network (>= 4:4.5.3)
* libqt4-sql (>= 4:4.5.3)
* libqt4-svg (>= 4:4.5.3)
* libqt4-xml (>= 4:4.5.3)
* libqt4-xmlpatterns (>= 4:4.5.3)
* libqtcore4 (>= 4:4.8.0)
* libqtgui4 (>= 4:4.8.0)
* libqtwebkit4 (>= 2.2~2011week36)
* libstdc++6 (>= 4.4.0)
* phonon
* libqt4-sql-sqlite

### Build Dependencies

* cmake (>= 2.8)
* autotools-dev
* libqt4-dev
* qt4-qmake
* libphonon-dev
* libqtwebkit-dev
* sqlite3

### Compiling

    $ mkdir /tmp/brewtarget-build
    $ cd /tmp/brewtarget-build
    $ cmake /path/to/brewtarget
    $ make

### Installing

Linux-like systems may simply do:

    $ sudo make install

Systems that use .deb or .rpm packages may also create a package first:

    $ make package

Then either

    $ sudo dpkg -i brewtarget*.deb

or

    $ sudo rpm -i brewtarget*.rpm

On Mac and Windows environments, the `package` target will create an installer
that may be executed to finish the installation.

### Make targets

* `make package`
  Makes .deb, .rpm, and .tar.bz2 binary packages.
* `make package_source`
  Makes a .tar.bz2 source package.
* `make source_doc`
  Makes html documentation of the source in doc/html.
* `make translations`
  If the cmake option `UPDATE_TRANSLATIONS` is set, updates the `*.ts` files
  and creates .qm files. Otherwise, just creates .qm files from `*.ts` files.

### Cmake options

These options are passed to `cmake` with the `-D` flag before compiling. For
example:

    $ cmake /path/to/brewtarget -DCMAKE_INSTALL_PREFIX=/usr -DDO_RELEASE_BUILD=ON

* `CMAKE_INSTALL_PREFIX` - `/usr/local` by default. Set this to `/usr` on
  Debian-based systems like Ubuntu.
* `BUILD_DESIGNER_PLUGINS` - `OFF` by default. If set to `ON`, builds the Qt Designer
  plugins instead of brewtarget.
* `DO_RELEASE_BUILD` - `OFF` by default. If `ON`, will do a release build.
  Otherwise, debug build.
* `ENABLE_PROFILING` - `OFF` by default. If `ON`, builds with 
  profiling compiler flags.
* `NO_PHONON` - `OFF` by default. If `ON`, does not build any Phonon code.
* `NO_MESSING_WITH_FLAGS` - `OFF` by default. `ON` means do not add any build
   flags whatsoever. May override other options.


721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	1	# Brewtarget
	2
	3	Brewtarget is free open-source brewing software, and a beer recipe creation
	4	tool available for Linux, Mac, and Windows. It automatically calculates color,
	5	bitterness, and other parameters for you while you drag and drop ingredients
	6	into the recipe. Brewtarget also has many other tools such as priming sugar
	7	calculators, OG correction help, and a unique mash designing tool. It also can
	8	export and import recipes in BeerXML, allowing you to easily share recipes with
	9	friends who use BeerSmith or other programs. All of this means that Brewtarget
	10	is your single, free, go-to tool when crafting your beer recipes.
	11
	12	## Authors
	13
	14	* Philip G. Lee <rocketman768@gmail.com> - Lead developer
	15	* Mik Firestone <mikfire@gmail.com>
782 by Philip G. Lee Updated author lists	16	* Maxime Lavigne <duguigne@gmail.com>
721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	17	* Dan Cavanagh <dan@dancavanagh.com>
	18	* Rob Taylor <robtaylor@floopily.org>
	19	* Kregg K <gigatropolis@yahoo.com>
	20	* A.J. Drobnich <aj.drobnich@gmail.com>
	21	* Ted Wright <tedwright@users.sourceforge.net>
	22	* Charles Fourneau (plut0nium) <charles.fourneau@gmail.com>
782 by Philip G. Lee Updated author lists	23	* Maxime Lavigne (malavv) <duguigne@gmail.com>
721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	24	* Peter Buelow <goballstate@gmail.com>
782 by Philip G. Lee Updated author lists	25	* David Grundberg <individ@acc.umu.se>
721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	26	* Tim Payne <swstim@gmail.com>
782 by Philip G. Lee Updated author lists	27	* Samuel Östling <MrOstling@gmail.com>
721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	28	* Luke Vincent <luke.r.vincent@gmail.com>
	29	* Eric Tamme <etamme@gmail.com>
	30	* Julein <j2bweb@gmail.com>
	31	* Jeff Bailey <skydvr38@verizon.net>
	32	* Piotr Przybyla (przybysh) <przybysh@gmail.com>
	33	* Chris Hamilton <marker5a@gmail.com>
	34
	35	Author list created with:
	36
	37	$ git log --raw \| grep "^Author: " \| sort \| uniq -c \| sort -nr
	38
	39	## Websites
	40
	41	* [Main website](http://www.brewtarget.org)
	42	* [Google group](https://groups.google.com/forum/?fromgroups=#!forum/brewtarget-help)
	43	* [Source code repository](http://www.gitorious.org/brewtarget)
	44	* [Project development page](https://launchpad.net/brewtarget)
	45	* [Bug tracker](https://bugs.launchpad.net/brewtarget)
	46	* [Developers team](https://launchpad.net/~brewtarget-devs)
770.1.1 by Philip G. Lee Added a script to set up a git environment for devs	47	* [Developers Wiki](https://gitorious.org/brewtarget/pages/Home)
721.1.10 by Philip G. Lee Decided to add .markdown extension to README.	48
	49	## Compiling and Installing
	50
	51	### Dependencies
	52
	53	Most of these can be satisfied by installing qt and a compiler.
	54
	55	* libc6 (>= 2.14)
	56	* libgcc1 (>= 1:4.1.1)
	57	* libphonon4 (>= 4:4.2.0)
	58	* libqt4-network (>= 4:4.5.3)
	59	* libqt4-sql (>= 4:4.5.3)
	60	* libqt4-svg (>= 4:4.5.3)
	61	* libqt4-xml (>= 4:4.5.3)
	62	* libqt4-xmlpatterns (>= 4:4.5.3)
	63	* libqtcore4 (>= 4:4.8.0)
	64	* libqtgui4 (>= 4:4.8.0)
	65	* libqtwebkit4 (>= 2.2~2011week36)
	66	* libstdc++6 (>= 4.4.0)
	67	* phonon
	68	* libqt4-sql-sqlite
	69
	70	### Build Dependencies
	71
	72	* cmake (>= 2.8)
	73	* autotools-dev
	74	* libqt4-dev
	75	* qt4-qmake
	76	* libphonon-dev
	77	* libqtwebkit-dev
	78	* sqlite3
	79
	80	### Compiling
	81
	82	$ mkdir /tmp/brewtarget-build
	83	$ cd /tmp/brewtarget-build
	84	$ cmake /path/to/brewtarget
	85	$ make
	86
	87	### Installing
	88
	89	Linux-like systems may simply do:
	90
	91	$ sudo make install
	92
	93	Systems that use .deb or .rpm packages may also create a package first:
	94
	95	$ make package
	96
	97	Then either
	98
	99	$ sudo dpkg -i brewtarget*.deb
	100
	101	or
	102
	103	$ sudo rpm -i brewtarget*.rpm
	104
	105	On Mac and Windows environments, the `package` target will create an installer
	106	that may be executed to finish the installation.
	107
	108	### Make targets
	109
	110	* `make package`
	111	Makes .deb, .rpm, and .tar.bz2 binary packages.
112	* `make package_source`
113	Makes a .tar.bz2 source package.
114	* `make source_doc`
115	Makes html documentation of the source in doc/html.
116	* `make translations`
117	If the cmake option `UPDATE_TRANSLATIONS` is set, updates the `*.ts` files
118	and creates .qm files. Otherwise, just creates .qm files from `*.ts` files.
119
120	### Cmake options
121
122	These options are passed to `cmake` with the `-D` flag before compiling. For
123	example:
124
125	$ cmake /path/to/brewtarget -DCMAKE_INSTALL_PREFIX=/usr -DDO_RELEASE_BUILD=ON
126
127	* `CMAKE_INSTALL_PREFIX` - `/usr/local` by default. Set this to `/usr` on
128	Debian-based systems like Ubuntu.
129	* `BUILD_DESIGNER_PLUGINS` - `OFF` by default. If set to `ON`, builds the Qt Designer
130	plugins instead of brewtarget.
131	* `DO_RELEASE_BUILD` - `OFF` by default. If `ON`, will do a release build.
132	Otherwise, debug build.
133	* `ENABLE_PROFILING` - `OFF` by default. If `ON`, builds with
134	profiling compiler flags.
135	* `NO_PHONON` - `OFF` by default. If `ON`, does not build any Phonon code.
136	* `NO_MESSING_WITH_FLAGS` - `OFF` by default. `ON` means do not add any build
137	flags whatsoever. May override other options.
138