Skip to content
This repository has been archived by the owner on Sep 7, 2022. It is now read-only.

Commit

Permalink
Prepared documentation and stats for release v1.5
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewdunsdon committed May 7, 2014
1 parent 749745f commit b739016
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 50 deletions.
15 changes: 7 additions & 8 deletions enyo/README.md
Expand Up @@ -14,14 +14,13 @@ Enyo has a dependency mechanism (package.js) to enable a basic modular approach

##Application Structure

repo/
...
enyo/ #this is the project directory and where index.html (for a deployed app) and debug.html (for building and testing) are located
assets/ #this is where you can place application assets, such as images
enyo/ #the unminified framework source
lib/ #the unminified module sources
source/ #the application source
...
+ `src/`
+ `enyo/` - the unminified framework source
+ `lib/` - the unminified module sources
+ `source/` - the application source
+ `index.html` - for a deployed app
+ `debug.html` - for building and testing
+ `assets/` - application assets, such as images, as well as icons and splashscreens used by PhoneGap

##Building The Application

Expand Down
26 changes: 7 additions & 19 deletions lavaca/README.md
Expand Up @@ -22,36 +22,23 @@ The Lavaca implementation of PropertyCross is built for iOS, Android, and Web. A

## Building the Application

1. __Get the code__
```bash
$ mkdir propertycross && cd propertycross
$ git clone https://github.com/georgehenderson/PropertyCross-Lavaca.git .
$ # Go to "lavaca" directory
$ cd lavaca
```

2. __Install grunt-cli globally__
Note: this may require sudo
```bash
$ # Install grunt-cli globally - this may require sudo
$ npm install -g grunt-cli
```

3. __Install bower globally__
Note: this may require sudo
```bash
$ # Install bower globally - this may require sudo
$ npm install -g bower
```

4. __Install node dependencies for our tasks to work__
```bash
$ # Install node dependencies for
$ npm install
```

5. __Install bower dependencies__
```bash
$ # Install bower dependencies
$ bower install
```


### Run Development Server

```bash
Expand All @@ -66,7 +53,7 @@ Your application should now be running on `localhost:8080`.
$ grunt build:production
```

This task creates a build directory with the Web code ready for deployment. The iOs and Android code projects are in `cordova/platforms`.
This task creates a build directory with the Web code ready for deployment. The iOS and Android code projects are in `cordova/platforms`.

### Package Builds for Native Deployment

Expand All @@ -86,6 +73,7 @@ or
$ grunt pkg:android
```

### Performing Deployment
libimobiledevice is required to install and uninstall packages to/from iOS devices. Mac OS X users may use [https://github.com/benvium/libimobiledevice-macosx](https://github.com/benvium/libimobiledevice-macosx).
adb is required to install and uninstall packages to/from Android devices.

Expand Down
14 changes: 9 additions & 5 deletions lavaca/package.json
@@ -1,9 +1,13 @@
{
"name": "lavaca-starter",
"version": "2.3.2",
"description": "A Lavaca app",
"main": "Gruntfile.js",
"url": "http://getlavaca.com",
"name": "lavaca",
"version": "1.0.0",
"implName": "lavaca",
"contributors": [{
"name": "George Henderson",
"username": "georgehenderson",
"hash": "a7c81a624fd68bde3e032853c8af7dbe"
}],
"platforms": ["android", "ios"],
"devDependencies": {
"mout": "0.x",
"fs-extra": "~0.6.3",
Expand Down
4 changes: 2 additions & 2 deletions native/README.md
@@ -1,7 +1,7 @@
Native PropertyCross
====================

These are the native implementations of the Property Finder application, included as reference.
These are the native implementations of the Property Cross application, included as reference.

## Introduction

Expand All @@ -11,7 +11,7 @@ The iOS application is built using Xcode, the Windows Phone application is built

## Building the iOS and Windows Phone applications

The iOS version is built using XCode4.5, the Windows Phone version using Visual Studio and the Windows Phone 7.1 SDKs.
The iOS version is built using XCode5.1, the Windows Phone version using Visual Studio and the Windows Phone 7.1 SDKs.

## Building the Android Application

Expand Down
30 changes: 16 additions & 14 deletions senchatouch2/README.md
Expand Up @@ -6,7 +6,7 @@ Visit the [Sencha Touch 2 page](http://propertycross.com/sencha-touch-2/) on the

[Sencha Touch](http://www.sencha.com/products/touch) is a framework for building cross-platform mobile application using HTML5 technologies. Similar to ExtJS, Sencha Touch provides a fully functional JavaScript API and a structured MVC approach for building mobile applications. Coding is done (almost!) exclusively in JavaScript - with the majority of the HTML and CSS being abstracted away behind the concept of "components", which are configured and generated by the JavaScript code.

The PropertyCross implementation does not use any additional tools or libraries beyond those supplied by Sencha, with one exception - it makes use of PhoneGap Build to build and package the application as a native app (although it does not make use of the PhoneGap APIs itself). This implementation also uses the default "Sencha" theme to style it - whereas other frameworks have attempted to mimic the default look and feel of native applications, Sencha Touch has opted for provided its own styling which provides a clean interface which looks the same on both iOS and Android browsers.
The PropertyCross implementation does not use any additional tools or libraries beyond those supplied by Sencha, with one exception - it makes use of PhoneGap Build to build and package the application as a native app (although it does not make use of the PhoneGap APIs itself). This implementation also uses the "Sencha" 2.3.1 themes to style it - mimicking the default look and feel of native applications for iOS 7, Android and Windows Phone 8.

## Building the Application

Expand All @@ -30,19 +30,21 @@ We have been unable to get the successfully produce a native package using the [

##Application Structure

+ `\.sencha` - Sencha project and workspace files.
+ `\app\controller` - Contains the application business logic.
+ `\app\model` - Configures persisted model objects.
+ `\app\store` - Sencha data stores representing either collections of data loaded from the server, or persisted model objects.
+ `\app\util` - Simple utility functions.
+ `\app\view` - The various Sencha views used by the app.
+ `\assets` - icons and splashscreens used by PhoneGap, these are generated via the [PropertyCross build system](https://github.com/ColinEberhardt/PropertyCross/tree/master/build).
+ `\resources` - The Sencha standard styles and customisation (SASS/CSS).
+ `\touch` - The Sencha Touch framework JS files.
+ `app.js` - The application bootstrap.
+ `app.json` - Application metadata/config.
+ `build.xml` - Sencha build process configuration.
+ `src\`
+ `.sencha\` - Sencha project and workspace files.
+ `app\controller\` - Contains the application business logic.
+ `app\model\` - Configures persisted model objects.
+ `app\store\` - Sencha data stores representing either collections of data loaded from the server, or persisted model objects.
+ `app\util\` - Simple utility functions.
+ `app\view\` - The various Sencha views used by the app.
+ `resources\` - The Sencha standard styles and customisation (SASS/CSS).
+ `touch\` - The Sencha Touch framework JS files.
+ `app.js` - The application bootstrap.
+ `app.json` - Application metadata/config.
+ `build.xml` - Sencha build process configuration.
+ `index.html` - The host HTML page for this app.
+ `www\`
+ `assets\` - icons and splashscreens used by PhoneGap, these are generated via the [PropertyCross build system](https://github.com/ColinEberhardt/PropertyCross/tree/master/build).
+ `config.xml` - The XML file that is used by PhoneGap Build in order to package the app.
+ `index.html` - The host HTML page for this app.
+ `phonegap.js` - The PhoneGap JavaScript APIs.
+ `stats-config.json` - Used by the PropertyCross build in order to compute code sharing metrics.
4 changes: 2 additions & 2 deletions xamarin/stats-config.json
@@ -1,8 +1,8 @@
{
"common": "common/*.cs",
"ios": {
"include":"iphone/PropertyFinder/*.cs",
"exclude":"iphone/PropertyFinder/*.designer.cs"
"include":"iphone/PropertyCross/*.cs",
"exclude":"iphone/PropertyCross/*.designer.cs"
},
"android": {
"include":"android/PropertyCross/*.cs",
Expand Down

0 comments on commit b739016

Please sign in to comment.