Updating templates to new comment stylings
[baulk.git] / README
blobc80ca520d56444466dda3e4cf64dc9013f80724c
1 // Baulk ******************************************************************************************
3 Baulk is a cross-platform native application tiling management tool written in Qt4. An emphasis is made on making all major components a separate dynamic library, for modularity.
6 Baulk is a complete rewrite of QuillTex (also written by me, which was in its third complete rewrite).
7 At current QuillTex is far more usable, and has WAY more working features, mind you only in Linux.
8 You can find QuillTex at http://quilltex.sf.net, and currently the SVN source is lightyears ahead of the released version. It has a plethora of features above the release, and a plethora of bugs to go with it. 
9 The released version has very few bugs.
12 // History ****************************************************************************************
14 Aug 10 2007 - QFS 1 Started (QuillTex from Scratch)
16 Feb 18 2008 - QFS 2 Started
18 May 21 2008 - QFS 3 Started
20 Jun 26 2008 - Released QuillTex 0.1
22 Oct 01 2008 - Baulk Started
24 Oct 19 2008 - "Baulk Daemons poised to rule the world", in other news, Baulk Daemon is functionally working
26 Oct 25 2008 - Win32 officially supported in Baulk
28 Nov 7  2008 - Baulk attains basic tiling functionality
31 // Dependencies ***********************************************************************************
33 Dependencies:
35 Qt 4.4
38 Build Dependencies:
40 Qt 4.4 Dev
41 cmake 2.6
43 (Optional)
45 doxygen
46 graphviz
49 Linux Build Dependencies:
51 cvs
52 gcc-c++ (A relatively new one, I use 4.3.2)
55 Win32 Build Dependencies:
57 mingw (I use the one with Qt 4.4)
60 // How to Build, then Run *************************************************************************
62 Linux
64 cd src
65 cmake .
66 make
67 cd ../bin
68 ./baulk
71 Win32
73 (Remember to setup your paths)
74 cd src
75 cmake .
76 make
77 cd ..\bin
78 baulk.exe
81 // Troubleshooting ********************************************************************************
83 If you're having issues building, just ask, I'm more than willing to help.
85 If you're having runtime issues, take a look at the console messages, they'll tell you whats going on.
88 // Contact ****************************************************************************************
90 If you don't know how to get a hold of me, I'd recommend the mailing list. 
91 I'll setup a mailing list for