From 8b5047938cd1c8e320f5c5e33aef93fc1a423001 Mon Sep 17 00:00:00 2001
From: chenchengfang <chenchengfang@pansi.me>
Date: Thu, 25 Apr 2013 16:36:36 +0800
Subject: [PATCH] add readme

---
 README.md   | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 ipa-publish |  2 +-
 2 files changed, 57 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7d3254d..ff9ad43 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,58 @@
-xcode_shell
+Introduce
 ===========
+----
+
+This repository contains a series of useful shell scripts which can help you to work effectively when programming for iOS platform.
+
+
+Necessary
+===========
+
+-----
+To use scripts of this repository, you should install the "Command Line Tools" in the setting of xcode first.
+
+
+Detail
+===========
+
+----
+
+####1.compile and package xcode project
+
+You can do this by using "ipa-build" shell script.
+
+**ipa-build**:This script is created to compile the xcode project and package the project to an ipa file.
+
+Usage: 
+
+	ipa-build <project directory> [-c <project configuration>] [-o <ipa output directory>] [-n]
+
+Options:
+
+	-c NAME		the configuration of project used to compile.Default is Release
+	-o PATH		output path for ipa file(must be a directory)
+	-n			clean the project before compling
+	
+If script executed successfully,an ipa file is created in the path: <project path>/build/ipa-build.
+
+
+####2.publish project
+
+**ipa-publish**: I will write it later.
+
+
+####3.add @2x suffix to image files
+
+When programming for retina device of iOS,the image file you used should add the suffix of @2x. Using the script "add2x" can help you do this automaticly.
+
+**add2x**: add suffix of @2x to all the image files(just png and jpg file) .This script work in the current directory.
+
+Usage:    
+1. go to the directory which contains images should be added suffix.    
+2. execute the add2x script.
+
+**note**: There is a bug of this script.If your image file name contains blank spaces, script can not work correctly.
+
+
+
 
-shell script that used to auto-build xcode project
\ No newline at end of file
diff --git a/ipa-publish b/ipa-publish
index 6c5fe60..ee435b4 100755
--- a/ipa-publish
+++ b/ipa-publish
@@ -259,7 +259,7 @@ ${shell_path}/sftpUploadFile ${serverIndexHtmlName} ${sftp_server} ${sftp_userna
 #发送邮件
 if [ $should_email = y ];then
 	email_title="${ipa_name}-IOS客户端更新"
-	email_content="hi,\n\n    The app is updated recently.Use the safari browser on IOS device to download the app.Here is the URL: ${pulish_url}/${target_name} \n\n   To see all the iOS projects of pansi, open this URL: ${pulish_url} \n\n\n   This email is sent by the automantic shell which is created by ccf,so do not reply this email.\n\n\n\n\n  Thanks!"
+	email_content="hi,\n\n    The app is updated recently.Use the safari browser on IOS device to download the app.Here is the URL: ${pulish_url}/${target_name} \n\n   To see the list of all iOS projects, open this URL: ${pulish_url} \n\n\n   This email is sent by the automantic shell which is created by ccf,so do not reply this email.\n\n\n\n\n  Thanks!"
 	${shell_path}/sendEmail -f ${email_sender} -t ${email_reciver} -s ${email_smtphost} -u ${email_title} -xu ${email_username} -xp ${email_password} -m ${email_content}
 fi