power-build 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 837ff8e14530640ef25bbdfaab302f2eb94a88f7
-  data.tar.gz: a668b9bcb396ffb681046da576b6c44e906f41a3
+  metadata.gz: 4deaba60aee516b39ec1f141c758e4afeed77dac
+  data.tar.gz: 71c47bd357385c7186ded93c4f76e21b1844859a
 SHA512:
-  metadata.gz: 53be60fa8a60a0ece7753bd5461ed09f7c08d8024af68fc6064558ee95e4b353f0f90321b7bcf3cdd4bfab0f497ae9fd49e68467171dc3479703ece5745e60c8
-  data.tar.gz: eed65f71796c2f9d3ba2fae51e790d60f75381e4f8c6cd6492156dd1827e28e6f7c8915cf050c6f91252e771605b7ec9cf1c7ed740f49d2c50f863b5d8a23791
+  metadata.gz: 961f890c061123509f04ec56a8aca9664275082a2e20828dc05b9933cc005abe241a299b291284f96492e41f9b2dc6520f04fb23a8ad09b2836ee1ed99311b60
+  data.tar.gz: 433c70b5a2708c735f83d8881c0e9586126190093e1760b9de597f97b986bfe42fe962a8fa4ad06c9a537bf6a9f5a51645c9ad690d059c5d6b1721f34008bd00

data/.gitignore

@@ -1,7 +1,6 @@
 *.gem
 *.rbc
 .bundle
-.config
 .yardoc
 Gemfile.lock
 InstalledFiles

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 gem 'thor'
 gem 'colorize'
 gem 'rspec'
+gem 'pry'

data/README.md

@@ -2,10 +2,13 @@
 
 Power Build is a photo album builder which generates a site based on the images in a project. It works as a command line application.
 
+#### Visit [Demo Site](http://cstony0917.github.io/warofpic/) for a general understanding.
+
 ## Requirement
 
-1. Ruby is installed in your Mac or Linux. (Don't use this application in Windows. Nothing has been tested.)
-2. The generated site is to be hosted on [GitHub pages](https://pages.github.com/).
+1. Ruby version 2.0 or higher
+2. Mac or Linux (Nothing has been tested on Windows.)
+3. This tool is for hosting on [GitHub pages](https://pages.github.com/). Other sites may not be compatible.
 
 ## Installation
 
@@ -17,7 +20,7 @@ $gem install power-build
 
 or manually write `gem 'power-build'` in the Gemfile before you run `$bundle`.
 
-## Usage
+## Commands
 
 In the root of your project, run:
 
@@ -31,4 +34,73 @@ It creates a config file in your project directory. You can adjust the content d
 $power build
 ```
 
-You can skip the `build` and just run `power`. This command generates a static site which allows you to host on github pages. Basically it creates a `index.html` and a folder `album` with other pages in it.
+You can skip the `build` and just run `power`. This command generates a static site which allows you to host on github pages. Basically it creates a `index.html` and a folder `assets` with other pages in it.
+
+```
+$power delete
+```
+
+Clean all files generated by power-build.
+
+## Config
+
+The config file looks like this:
+
+```
+{
+  "title": "Your Site Title",
+
+  // Displaying the source on you nav-bar
+  "host_link": "https://github.com/nkj20932/power-build",
+  "host_display_text": "GitHub",
+
+  // Select the folder you store images
+  "root_folder": "storage",
+
+  // Website language: either "zh-tw" or "en"
+  "language": "zh-tw"
+}
+
+```
+
+1. Remember to keep the file content in JSON format. Don't break it.
+2. Currently there are only two languages for display: English and Traditional Chinese.
+3. `root_folder` for the images should be in your root folder. Otherwise the links and images will not be displayed. Check the folder structure in the next section.
+
+## Folder Structure
+
+Before site generation, you need to include at least the folder of your images:
+
+```
+My_project_folder
+|-- image_root_folder
+```
+
+If so, after site generation, your folder will look like this:
+
+```
+My_project_folder
+|-- image_root_folder
+|-- power-build.config
+|-- assets
+|-- index.html
+```
+
+However, in your image folder, the images should be stored by categories like this:
+
+```
+image_root_folder
+|-- category_1
+|    |--  image_1
+|    |--  image_2
+|    |--  image_3
+|
+|-- category_2
+|-- category_3
+```
+
+Only the structure is followed can the site be generated in the correct format as in the [demo](http://cstony0917.github.io/warofpic/).
+
+## Issues & Contribution
+
+The project follows MIT Licence. Any issue, pull-request, feature-request, or comment is welcome.

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+task :install do
+  command = %x[cd ~/projects/power-build]
+  command = %x[gem build power-build.gemspec]
+  command = %x[cd ~/projects/power-build/pkg]
+  command = %x[gem install power-build-1.0.0.gem]
+  puts "Done!"
+end