Misc structure

artyfarty · Jan 24, 2012 · cc32b07 · cc32b07
1 parent 328bc2c
commit cc32b07
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 0 deletions.
diff --git a/UniversalEmoticonPackBuilder/README.md b/UniversalEmoticonPackBuilder/README.md
@@ -0,0 +1,49 @@
+# UniversalEmoticonPackBuilder
+UniversalEmoticonPackBuilder is a tool to build an emoticon packs for multiple clients
+
+For now QIP Infium/2010, Pidgin and Adium support is complete.
+
+Licence: [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-nc-sa/3.0/)
+
+## Solution projects
+* UniversalEmoticonPackBuilder — console utility
+* UniversalEmoticonPackBuilderLib — builder itself
+* qip_buildmap — creates UniversalEmoticonPackBuilder map from qip smilepack _define.ini
+
+## Usage
+First you need to create a pack to build. Check the *examplePack/* for a simple example.
+
+Basically you need a **mapfile** and a **build config**.
+
+### Mapfile
+Mapfile defines which codes corresponds to emoticon images
+
+```
+imagefile:code[,alternativecode[,alternativecode[,alternativecode ... ]]]
+```
+
+### Build config
+Build config defines a basic metainfo of the pack and sets the name of the mapfile.
+
+```
+{
+	"name":"Example",
+	"version":"1.0",
+	"author":"artyfarty",
+	"map":"map.uemap",
+	"builders":["qip","adium","pidgin"]
+}
+```
+You can also select which builders (clients) to use.
+You can look up more builders in the source or write your own.
+
+### Building
+Now place mapfile, config and images in the same dir and point the console utility on the config:
+
+```
+uepackbuild "C:/blah blah/fooPack/config.json"
+```
+
+Or add **uepackbuild** to PATH and launch it from pack dir without params.
+
+Congrats! Now you have *example_1.0_by_artyfarty_for_adium.zip*, *example_1.0_by_artyfarty_for_pidgin.zip* and *example_1.0_by_artyfarty_for_qip.zip* in *C:/blah blah/fooPack/build/* dir, ready for distribution.
diff --git a/UniversalEmoticonPackBuilder/emoticon_build.csproj b/UniversalEmoticonPackBuilder/emoticon_build.csproj
@@ -48,6 +48,9 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
+    <Content Include="license.txt">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
     <Content Include="templates\chrome.user.js">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
@@ -58,6 +61,11 @@
       <Name>UniversalEmoticonPackBuilderLib</Name>
     </ProjectReference>
   </ItemGroup>
+  <ItemGroup>
+    <None Include="README.md">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

diff --git a/UniversalEmoticonPackBuilder/license.txt b/UniversalEmoticonPackBuilder/license.txt
@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
diff --git a/UniversalEmoticonPackBuilderLib/UniversalEmoticonPackBuilderLib.csproj b/UniversalEmoticonPackBuilderLib/UniversalEmoticonPackBuilderLib.csproj
@@ -50,6 +50,11 @@
     <Compile Include="TemplateWriter.cs" />
     <Compile Include="Builders.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="license.txt">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.

diff --git a/UniversalEmoticonPackBuilderLib/license.txt b/UniversalEmoticonPackBuilderLib/license.txt
@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
diff --git a/qip_buildmap/license.txt b/qip_buildmap/license.txt
@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
diff --git a/qip_buildmap/qip_buildmap.csproj b/qip_buildmap/qip_buildmap.csproj
@@ -46,6 +46,11 @@
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="license.txt">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.