Skip to content

Commit 67ab096

Browse files
author
Philip Dow
committed
Added README for github
1 parent 6616b42 commit 67ab096

File tree

2 files changed

+123
-0
lines changed

2 files changed

+123
-0
lines changed

Journler.xcodeproj/project.pbxproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@
499499
29B97325FDCFA39411CA2CEA /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = /System/Library/Frameworks/Foundation.framework; sourceTree = "<absolute>"; };
500500
32CA4F630368D1EE00C91783 /* Journler_Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Journler_Prefix.pch; sourceTree = "<group>"; };
501501
721DE49C0DD2AC5700AB7438 /* SproutedAVI.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; path = SproutedAVI.framework; sourceTree = "<group>"; };
502+
7220B855146B206100CBFE76 /* README.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.txt; sourceTree = "<group>"; };
502503
726EC0570CCC512C008AE420 /* SmallEntryIcon.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = SmallEntryIcon.png; sourceTree = "<group>"; };
503504
726EC0580CCC512C008AE420 /* SmallAltDisclosure.tif */ = {isa = PBXFileReference; lastKnownFileType = image.tiff; path = SmallAltDisclosure.tif; sourceTree = "<group>"; };
504505
726EC0590CCC512C008AE420 /* SmallDisclosure.tif */ = {isa = PBXFileReference; lastKnownFileType = image.tiff; path = SmallDisclosure.tif; sourceTree = "<group>"; };
@@ -1210,6 +1211,7 @@
12101211
29B97314FDCFA39411CA2CEA /* Journler */ = {
12111212
isa = PBXGroup;
12121213
children = (
1214+
7220B855146B206100CBFE76 /* README.txt */,
12131215
72D1248913D51B01002202F1 /* 2.6 Changelog.rtf */,
12141216
72D124F313D5F9EB002202F1 /* 2.6 Notes.rtf */,
12151217
080E96DDFE201D6D7F000001 /* Classes */,

README.txt

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
//
2+
// Journler
3+
// Created by Philip Dow
4+
// Copyright Philip Dow / Sprouted. All rights reserved.
5+
//
6+
7+
/*
8+
Redistribution and use in source and binary forms, with or without modification, are permitted
9+
provided that the following conditions are met:
10+
11+
* Redistributions of source code must retain the above copyright notice, this list of conditions
12+
and the following disclaimer.
13+
14+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions
15+
and the following disclaimer in the documentation and/or other materials provided with the
16+
distribution.
17+
18+
* Neither the name of the author nor the names of its contributors may be used to endorse or
19+
promote products derived from this software without specific prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
22+
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23+
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
24+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
27+
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
*/
30+
31+
/*
32+
33+
Journler uses the following open source software, many of whose source
34+
files are contained within the Journler code base. The Journler open source
35+
license does not supersede any licenses imposed by the included 3rd party code.
36+
If you find unaccredited code or improperly used licenses, please let me know.
37+
38+
- RBSplitView by Rainer Brockerhoff
39+
- LJKit by Benjamin Peter Ragheb
40+
- ID3 Framework by Chris Drew
41+
- XMLRPCCocoa by Brent Simmons
42+
- CURLHandle+extras by Dan Wood
43+
- The LAME encoder by the lame group at mp3dev.org
44+
- The LAME Framework and Quicktime Component by Lynn Pye
45+
- NDAlias by Nathan Day
46+
- KFAppleScript Additions by Ken Ferry
47+
- iMediaBrowser by Greg Hulands and the crew / Karelia
48+
- L0iPod by Emanuele Vulcano
49+
- CocoaSequenceGrabber by Tim Omernick
50+
- Sparkle framework by Andy Matuschak
51+
- Cool windows and other visual candy by Matt Gemmell
52+
- More cool windows and candy by Chad Weider
53+
- MUPhotoView by Blake Seely
54+
- The Pantomime framework by Ludovic Marcotte
55+
- UKKQueue by M. Uli Kusterer
56+
- GTResourceFork by Jonathan Grynspan
57+
- KBWordCountingTextStorage by Keith Blount
58+
59+
*/
60+
61+
//
62+
// SPROUTED DEPENDENCIES
63+
//
64+
// 1. SproutedUtilities
65+
// 2. SproutedInterface
66+
// 3. SproutedAVI
67+
//
68+
// Journler relies on a three additional frameworks from Sprouted. SproutedAVI handled\s
69+
// audio-visual input and is already available at github. The Utilities and
70+
// Interface frameworks are forthcoming.
71+
//
72+
// Initially I thought it wise to collect generic code used in Journler into these two
73+
// separate frameworks to improve their re-usability. I no longer believe this was
74+
// necessary, and a portion of the open sourcing effort includes the decomposition of these
75+
// frameworks into their constituent parts and the re-incorporation of that code back
76+
// into the main Journler project.
77+
//
78+
// The issue is not so much that the code is kept separate. In fact I will likely continue
79+
// to maintain separate repositories for re-usable code. The issue is that I combined this
80+
// code into a framework, whereas I should have just grabbed the source files from the
81+
// repository as I required them.
82+
//
83+
84+
85+
//
86+
// ABOUT JOURNLER OPEN SOURCE
87+
//
88+
// This is the complete Xcode project for the Journler application, including source code,
89+
// interface files and application resources, and it is the same code I am currently developing
90+
// for the 2.6 Mac OS compatibility update . Compiling this project will produce an application
91+
// identical to the current version of the publicly available 2.6b update. As I make improvements
92+
// to the code I will push them to github so that this repository should reflect changes to the
93+
// latest binaries.
94+
//
95+
// The 2.6 compatibility update is a significant undertaking. In addition to the Journler code
96+
// itself, I am also updating local frameworks on which the application is dependent as well as
97+
// incorporating newer versions of other 3rd party code and frameworks. The update mostly consists
98+
// of refactoring existing code and replacing deprecated API calls. To get an idea of just how much
99+
// work is involved, simply compile the application and have a look at the warnings.
100+
//
101+
// Moreover, the code is a mess, and much of it is four, five and even six years old, written
102+
// before I had developed solid object-oriented coding practices. Object coupling is a problem,
103+
// although the application does have clearly defined data and interface layers, and an overall
104+
// hierarchy should become evident upon investigation of the code. I may try to produce a diagram
105+
// detailing the relationships and spheres of influence for future development.
106+
//
107+
// A word about the data layer: it was written in the days before Core Data. If all you've ever
108+
// known is Core Data, welcome to the painful world of writing a quasi-relational database layer
109+
// from scratch in a time before you even realized that's what you were doing.
110+
//
111+
// Journler is not being open source for any specific reason. Although there is a hope that other
112+
// developers may pick up the code and customize it for their own use or improve it for general
113+
// use, I believe the significance of the application lies not so much in the implementation but
114+
// in the idea. The code is mostly obsolete, and a much more efficient project could be begun
115+
// from scratch to realize the Journler vision.
116+
//
117+
// The 2.6 update, however, is being completed specifically to ensure compatibility with new and
118+
// future versions of the Mac OS. I'm continually astonished by just how many people used and
119+
// continue to use Journler. Updating the code so that they may keep using it, even if no new
120+
// features are added, is the right thing to do.
121+
//

0 commit comments

Comments
 (0)