Skip to content
This repository was archived by the owner on Mar 26, 2018. It is now read-only.

Commit 9515b18

Browse files
committed
Close off repo, point to new fork
This repo will not be used anymore after this commit. Development has moved to https://github.com/bakerframework/baker/.
1 parent 1093770 commit 9515b18

File tree

3 files changed

+253
-262
lines changed

3 files changed

+253
-262
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
# Creating a new issue
1+
This repo is not maintained anymore.
22

3-
If you are having trouble with Baker, you can ask for help on the [issue board](https://github.com/Simbul/baker/issues) on Github. However, before you open a new issue, make sure you have followed these steps:
4-
5-
* Follow the relevant tutorial from the [wiki](https://github.com/Simbul/baker/wiki)
6-
* Make sure your question has not been answered in one of the [FAQs](https://github.com/Simbul/baker/wiki/Baker-Walkthrough-FAQ-for-Newbies)
7-
* If you've downloaded Baker from `bakerframework.com`, try updating to the latest [master branch](https://github.com/Simbul/baker/archive/master.zip) from Github
8-
9-
If you still need to open an issue, please make sure you follow the guidelines on the [Problems and Debugging](https://github.com/Simbul/baker/wiki/Problems-and-Debugging) page.
10-
11-
# Contributing code
12-
13-
If you want to contribute code to Baker, you can create a [pull request](https://help.github.com/articles/using-pull-requests) on Github. Please make sure that:
14-
15-
* Your pull request is based on the latest possible version of the Baker `master` branch
16-
* You have provided a meaningful title for your pull request
17-
* You have briefly explained in the pull request what it does and why it should be merged
18-
* You have referenced any relevant issue
3+
The new official fork can be found at https://github.com/bakerframework/baker/.

README.md

Lines changed: 2 additions & 245 deletions
Original file line numberDiff line numberDiff line change
@@ -1,249 +1,6 @@
11
Project Baker
22
=============
33

4-
**The HTML5 ebook framework to publish interactive books & magazines on iPad & iPhone using simply open web standards**
5-
<http://bakerframework.com>
4+
This is the original Baker Framework repository by Davide Casali, Marco Colombo and Alessandro Morandi. Note that this repo is not maintained anymore.
65

7-
8-
9-
WHAT IS BAKER
10-
-------------
11-
12-
To this day, ebooks have been limited by an old standard created in the pre-Kindle and pre-iPad era.
13-
Baker is the first stepping stone to show that we could already be using the powerful HTML5 language
14-
to create books with real typography, real layouts and high-quality design.
15-
16-
17-
18-
HOW TO USE BAKER
19-
----------------
20-
21-
Creating an ebook in HTML5 to be used with Baker is a three-steps operation.
22-
It's easier done than said! ;)
23-
24-
1. DESIGN
25-
* Create you publication as one or more **HTML5 files** like a standalone website
26-
* Design your publication to fit multiple screen (using CSS media-queries)
27-
* You can use **any** feature in WebKit: HTML5, CSS3, JavaScript (video, audio, fonts, jQuery, Google Maps, etc)
28-
* On iPad/iPhone you can constrain the height to match the page size or make it scrollable if you need longer pages
29-
* For best results, consider having 1 HTML for each chapter/section/article and use the native vertical scrolling.
30-
* ...remember: it's a publication. If you want to build an app, check [PhoneGap](http://www.phonegap.com/). ;)
31-
32-
2. PACKAGE
33-
* The publication must be contained in a single Hpub file
34-
* Each chapter/section/article (horizontally swiped on the iPad) should be a single HTML file inside the Hpub
35-
* Create a Hpub book.json file: title, author, pages, etc. (see below)
36-
* All the assets must be contained within the publication folder or its subfolders
37-
* Check the example book from the website for an hands-on example
38-
* See either [Standalone tutorial](https://github.com/Simbul/baker/wiki/Tutorial-for-Standalone-App) or [Newsstand tutorial](https://github.com/Simbul/baker/wiki/Tutorial-for-Newsstand-with-Free-issues) for more info
39-
40-
3. PUBLISH
41-
* Download the Baker Framework Xcode project from http://bakerframework.com (or GitHub).
42-
* Download Xcode from the Mac App Store or from the Apple Developer website.
43-
* Decide if you want to release using the [Standalone tutorial](https://github.com/Simbul/baker/wiki/Tutorial-for-Standalone-App) or [Newsstand tutorial](https://github.com/Simbul/baker/wiki/Tutorial-for-Newsstand-with-Free-issues) mode and follow the tutorial accordingly.
44-
* Select the Baker Scheme (Simulator or Device) from the toolbar dropdown.
45-
* Run and check that everything works correctly _both_ on simulator and device.
46-
* Check [this page](https://github.com/Simbul/baker/wiki/Problems-and-Debugging) if you encounter any problem.
47-
* Create an Apple iPhone Developer account to publish on the App Store.
48-
* If you are using Newsstand, follow the instruction on the Apple iPhone Developer website to create a new free subscription.
49-
* Follow the instructions on the Apple iPhone Developer website to submit your book to the app store.
50-
51-
52-
BOOK.JSON
53-
---------
54-
55-
This is an example of a minimal book.json file:
56-
57-
```json
58-
{
59-
"title": "The Study in Scarlet",
60-
"author": "Arthur Conan Doyle",
61-
"url": "book://bakerframework.com/books/arthurconandoyle-thestudyinscarlet",
62-
63-
"contents": [
64-
"Article-Lorem.html",
65-
"Article-Ipsum.html",
66-
"Article-Gaium.html",
67-
"Article-Sit.html",
68-
"Article-Amet.html"
69-
]
70-
}
71-
```
72-
73-
For all the details and the advanced options, check the [Hpub specification on the wiki](https://github.com/Simbul/baker/wiki/hpub-specification).
74-
75-
76-
SHELF.JSON
77-
----------
78-
79-
This is an example of the shelf.json file that is downloaded by Baker in Newsstand mode to check the available publications:
80-
81-
```json
82-
[
83-
{
84-
"name": "a-study-in-scarlet",
85-
"title": "A Study in Scarlet",
86-
"info": "The original masterpiece by Sir Arthur Conan Doyle",
87-
"date": "1887-10-10 10:10:10",
88-
"cover": "http://bakerframework.com/newsstand-books/a-study-in-scarlet.png",
89-
"url": "http://bakerframework.com/newsstand-books/a-study-in-scarlet.hpub",
90-
"product_id": "com.bakerframework.Baker.issues.a_study_in_scarlet"
91-
}
92-
]
93-
```
94-
95-
For all the details on how to create and use it, check the [Newsstand publications](https://github.com/Simbul/baker/wiki/4.0-tutorial-for-Newsstand).
96-
97-
98-
CREATE A BOOK FOR BOTH IPAD AND IPHONE
99-
--------------------------------------
100-
101-
With Baker Framework you can create books and magazines for the iPhone too.
102-
103-
To compile your application for iPhone follow these steps:
104-
105-
* Open the Baker Framework Xcode project with Xcode.
106-
* Click on the "Baker" project in the leftmost column of the project navigator.
107-
* On the column just left, click under Projects on "Baker"
108-
* In the "Build Settings" tab locate the section Deployment for the configuration you would like to use for compiling.
109-
* Under the Deployment section change the Target Device Family entry to match the devices you would like to target (only iPhone, only iPad or iPhone/iPad).
110-
* Update your publications to manage multiple orientations (using CSS media-queries).
111-
* Compile and test the application.
112-
113-
114-
115-
BUGS AND FEEDBACK
116-
-----------------
117-
118-
* Submit your bugs here: <http://github.com/simbul/baker/issues>
119-
* Give us your feedback at: <[email protected]>
120-
* Follow us on Twitter: <http://twitter.com/BakerFramework>
121-
122-
123-
124-
CHANGELOG
125-
---------
126-
127-
* **4.2** (28/10/2013)
128-
* iOS 7 support
129-
* Text Kit support
130-
* Support for analytics/tracking frameworks
131-
* Info box in shelf
132-
* `init` JS event for Info box with `user_id` and `app_id`
133-
* Asset Catalog support
134-
* Added `environment` parameter to Baker API calls
135-
* Made most remote calls asynchronous
136-
* Support for removing issues from `shelf.json`
137-
* Replaced AQGridView with UICollectionView
138-
* Minor improvements and bugfixes
139-
140-
* **4.1** (06/05/2013)
141-
* In-App Purchases for your magazine issues (server required)
142-
* Paid Subscriptions support (server required)
143-
* Push notifications capabilit (server required)
144-
* Baker API defined to allow third-party servers
145-
* Vertical pagination flexibility with `<meta name="paged" content="YES">`
146-
* Issue data can now be refreshed
147-
* book: protocol now works within the issues on the shelf
148-
* Index handling improvements
149-
* Removed JSONKit, using iOS5+ parser
150-
* Memory enhancements
151-
* Cleaned up the debug console log and error messages
152-
* Bugs and fixes
153-
154-
* **4.0** (22/12/2012)
155-
* Full Newsstand support
156-
* Shelf to manage multiple publications
157-
* Free subscriptions support
158-
* Orientation handling improvement
159-
160-
* **3.2.3** (25/10/2012)
161-
* Added more complete user-agent to work with JS that do user-agent detection for features
162-
* Fix: HTML5 Video playback now uses the Audio session
163-
* Fix: long touch doesn't trigger the index bar anymore
164-
165-
* **3.2.2** (10/10/2012)
166-
* iOS 6 and iPhone 5 display support
167-
* Improved modal web view offline handling
168-
* Fixed orientation bug and javascript property
169-
* Fixed modal web view crash when interrupted and other minor fixes
170-
* For developers: now Baker view is a separate class
171-
* User agent and status bar tweaks (thanks to @jcampbell05)
172-
173-
* **3.2.1** (20/08/2012)
174-
* Internal release
175-
176-
* **3.2** (20/03/2012)
177-
* iOS 5.1 and Retina display support
178-
* External links now open in internal browser, see referrer=Baker (thanks to @steiny2k)
179-
* Custom events fired on window blur and focus
180-
* Book.json parameters to disable tap and swipe: -baker-page-turn-tap/swipe
181-
* Index bar dynamically sized from index.html size. Use viewport meta property to configure
182-
* Change: referrer=Baker variable now not passed to destination website
183-
* Fix: "white flash" workaround found
184-
* Fix: solved issue with pre-compiled screenshots and books with more than 50 pages
185-
* Fix: rare bug of content loaded into index view instead of page
186-
187-
* **3.1** (20/12/2011)
188-
* Newsstand basic support
189-
* iOS5/iCloud data storage guidelines support
190-
* Pre-build screenshots in screenshot mode using -baker-page-screenshots in book.json
191-
* Retina display support in screenshot mode (thanks to @zenz)
192-
* Manga support: start from the last page, or any arbitrary page using -baker-start-at-page in book.json
193-
* Email protocol support
194-
* Change JSON library to JSONKit (thanks to @zenz)
195-
* Fix: block idle when downloading
196-
* Fix: spinner color and iOS4.x support
197-
* Change: -baker-background-image-* properties are now relative to ./book/ folder, see Issue #247
198-
199-
* **3.0.2** (29/10/2011)
200-
* Fix: iOS 4 support for the spinner feature available only in iOS 5
201-
202-
* **3.0** (18/10/2011)
203-
* Two rendering modes to improve performances: screenshots (thanks to @pugpig) and three-cards
204-
* index.html view on double-tap to manage navigation and menu
205-
* Full Hpub 1.0 support
206-
* Improved rendering speed and responsiveness
207-
* Improved handling of internal and external links
208-
* Memory optimization
209-
* iOS 5 and Xcode 4.2 compatibility
210-
* Minimum supported version: iOS 4.0
211-
* Minor fixes and improvements
212-
* Thanks to @francesctovar @therabidbanana @eaglejohn @ffranke for the great support
213-
214-
* **2.0** (28/04/2011)
215-
* Multi-orientation books support: portrait, landscape, both (thanks to @svdgraaf)
216-
* iPhone support
217-
* Xcode 4 compatibility
218-
* Added support to open a specific page of a downloaded book
219-
* Added support to remove vertical bounce (for non-scrolling books)
220-
* Added support to enable automatic media playback
221-
* Changed the gesture to open the status bar to the more reliable doubletap
222-
* Fix: page anchors now handled in internal links
223-
* Fix: orientationchange event now fires
224-
* Minimum supported version: iOS 3.2
225-
* Minor fixes
226-
227-
* **1.1** (19/01/2011)
228-
* Added book:// protocol to allow downloadable HPub books
229-
* Support for zipped HPub books (to allow downloading)
230-
* Link support (internal/external)
231-
* Multitap page navigation
232-
* Alphabetical ordering (WARNING: breaks previous books, check before upgrading)
233-
* Statusbar on tap
234-
* Full screen swipes
235-
* Fix: now the previous page doesn't flash anymore when you change page
236-
* Minor fixes
237-
238-
* **1.0** (03/11/2010)
239-
* First release
240-
241-
242-
LICENSE
243-
-------
244-
245-
_Copyright (C) 2010-2013, Davide Casali, Marco Colombo, Alessandro Morandi_
246-
_Licensed under **BSD Opensource License** (free for personal and commercial use)_
247-
248-
249-
> _Elementary, my dear Watson._
6+
The new official fork can be found at https://github.com/bakerframework/baker/.

0 commit comments

Comments
 (0)