Recent changes to User Guide

User Guide modified by Cheng JIANG

Cheng JIANG — Thu, 10 Jan 2019 12:36:41 -0000

--- v6
+++ v7
@@ -9,7 +9,7 @@
 1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
 2. unzip ./sky.zip -d sky
 3. cd ./sky/linux-x64
-4 chmod u+x ./sky
+4. chmod u+x ./sky
 5. ./sky
 ```

User Guide modified by Cheng JIANG

Cheng JIANG — Thu, 10 Jan 2019 11:34:23 -0000

--- v5
+++ v6
@@ -35,9 +35,11 @@

 ## Usage

+If you are using windows, please replace `./sky` by `.\sky.exe`.
+
 1. Load emails of specific period
 ```bash
-src/index.js lms \
+./sky lms \
     /path/to/data \ 
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -45,7 +47,7 @@

 2. Show exchanged emails of an employee 
 ```bash
-src/index.js nms \
+./sky nms \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \ 
     --date-from="[dd/][mm/]yyyy" \
@@ -54,7 +56,7 @@

 3. Show busy days of an employee
 ```bash
-src/index.js bsd \
+./sky bsd \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -62,7 +64,7 @@

 4. Show the top 10 contacts of an employee
 ```bash
-src/index.js tpc \
+./sky tpc \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
@@ -71,7 +73,7 @@

 5. Show the top 10 words used by an employee in his email subject
 ```bash
-src/index.js tpw \ 
+./sky tpw \ 
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -79,7 +81,7 @@

 6. Visualize sent and received emails of an employee 
 ```bash
-src/index.js emp \
+./sky emp \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -87,7 +89,7 @@

 7. Visualize sent emails of all collaborators
 ```bash
-src/index.js nbmc \
+./sky nbmc \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --date-from="[dd/][mm/]yyyy" \
@@ -96,7 +98,7 @@

 8. Visualize employee's frequency of sending emails
 ```bash
-src/index.js fmu \
+./sky fmu \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --employee="<employee's email="" name|employee's="" address="">" \
@@ -106,7 +108,7 @@

 9. Search emails by name of employee or email's content and subject
 ```bash
-src/index.js sbc \
+./sky sbc \
     /path/to/data \
     --employee="<employee's email="" name|employee's="" address="">" \
     --date-from="[dd/][mm/]yyyy" \
</employee's></employee's></employee's></employee's></employee's></employee's></employee's>

User Guide modified by Cheng JIANG

Cheng JIANG — Thu, 10 Jan 2019 11:29:38 -0000

--- v4
+++ v5
@@ -114,3 +114,8 @@
     --subject="text" \
     --content="text"
 ```
+
+
+## Redirect
+
+Click [here](https://sourceforge.net/p/sky-gl02/wiki/Developer%20Guide/) to read the developper guide.

User Guide modified by Cheng JIANG

Cheng JIANG — Thu, 10 Jan 2019 11:28:12 -0000

--- v3
+++ v4
@@ -1,16 +1,43 @@
-Welcome to the wiki of **Sky**, here is the user guide!
+Welcome to the wiki of `Sky`, here is the user guide!

 ## Installation
-* Download the project from [sourceforge](https://sourceforge.net/p/sky-gl02/code/HEAD/tarball)
-* Unzip it
-* Go to the **trunk** directory  and execute **npm install** in order to install the project dependencies
-* Go to the **trunk/src** directory and type **node index.js**
+
+You can install this application using prebuilt binary. Make sure you have `curl` and `zip` installed.
+
+`Linux`
+```bash
+1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
+2. unzip ./sky.zip -d sky
+3. cd ./sky/linux-x64
+4 chmod u+x ./sky
+5. ./sky
+```
+
+`MacOs`
+```bash
+1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
+2. unzip ./sky.zip -d sky
+3. cd ./sky/osx-x64
+4. chmod u+x ./sky
+5. ./sky
+```
+
+`Windows`
+```bash
+1. curl -L https://sourceforge.net/projects/sky-gl02/files/sky.zip > sky.zip
+2. unzip .\sky.zip -d sky
+3. cd .\sky\osx-x64
+4. .\sky.exe
+```
+
+Currently, prebuilt binary is not very stable, you may encounter some issues. If that happens please try to clone this project and install dependencies by your own.
+

 ## Usage

 1. Load emails of specific period
 ```bash
-node index.js lms \
+src/index.js lms \
     /path/to/data \ 
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -18,7 +45,7 @@

 2. Show exchanged emails of an employee 
 ```bash
-node index.js nms \
+src/index.js nms \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \ 
     --date-from="[dd/][mm/]yyyy" \
@@ -27,7 +54,7 @@

 3. Show busy days of an employee
 ```bash
-node index.js bsd \
+src/index.js bsd \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -35,7 +62,7 @@

 4. Show the top 10 contacts of an employee
 ```bash
-node index.js tpc \
+src/index.js tpc \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
@@ -44,7 +71,7 @@

 5. Show the top 10 words used by an employee in his email subject
 ```bash
-node index.js tpw \ 
+src/index.js tpw \ 
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -52,7 +79,7 @@

 6. Visualize sent and received emails of an employee 
 ```bash
-node index.js emp \
+src/index.js emp \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -60,7 +87,7 @@

 7. Visualize sent emails of all collaborators
 ```bash
-node index.js nbmc \
+src/index.js nbmc \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --date-from="[dd/][mm/]yyyy" \
@@ -69,7 +96,7 @@

 8. Visualize employee's frequency of sending emails
 ```bash
-node index.js fmu \
+src/index.js fmu \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --employee="<employee's email="" name|employee's="" address="">" \
@@ -79,7 +106,7 @@

 9. Search emails by name of employee or email's content and subject
 ```bash
-node index.js sbc \
+src/index.js sbc \
     /path/to/data \
     --employee="<employee's email="" name|employee's="" address="">" \
     --date-from="[dd/][mm/]yyyy" \
</employee's></employee's></employee's></employee's></employee's></employee's></employee's>

User Guide modified by Jacques Couderc

Jacques Couderc — Wed, 09 Jan 2019 13:57:45 -0000

--- v2
+++ v3
@@ -1,11 +1,16 @@
 Welcome to the wiki of **Sky**, here is the user guide!

+## Installation
+* Download the project from [sourceforge](https://sourceforge.net/p/sky-gl02/code/HEAD/tarball)
+* Unzip it
+* Go to the **trunk** directory  and execute **npm install** in order to install the project dependencies
+* Go to the **trunk/src** directory and type **node index.js**

 ## Usage

 1. Load emails of specific period
 ```bash
-src/index.js lms \
+node index.js lms \
     /path/to/data \ 
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -13,7 +18,7 @@

 2. Show exchanged emails of an employee 
 ```bash
-src/index.js nms \
+node index.js nms \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \ 
     --date-from="[dd/][mm/]yyyy" \
@@ -22,7 +27,7 @@

 3. Show busy days of an employee
 ```bash
-src/index.js bsd \
+node index.js bsd \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -30,7 +35,7 @@

 4. Show the top 10 contacts of an employee
 ```bash
-src/index.js tpc \
+node index.js tpc \
     /path/to/data \
     <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
@@ -39,7 +44,7 @@

 5. Show the top 10 words used by an employee in his email subject
 ```bash
-src/index.js tpw \ 
+node index.js tpw \ 
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -47,7 +52,7 @@

 6. Visualize sent and received emails of an employee 
 ```bash
-src/index.js emp \
+node index.js emp \
     /path/to/data <employee's email="" address="" employee's="" name="" |=""> \
     --date-from="[dd/][mm/]yyyy" \
     --date-to="[dd/][mm/]yyyy"
@@ -55,7 +60,7 @@

 7. Visualize sent emails of all collaborators
 ```bash
-src/index.js nbmc \
+node index.js nbmc \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --date-from="[dd/][mm/]yyyy" \
@@ -64,7 +69,7 @@

 8. Visualize employee's frequency of sending emails
 ```bash
-src/index.js fmu \
+node index.js fmu \
     /path/to/data \
     --file="/path/to/save/svg/or/png" \
     --employee="<employee's email="" name|employee's="" address="">" \
@@ -74,7 +79,7 @@

 9. Search emails by name of employee or email's content and subject
 ```bash
-src/index.js sbc \
+node index.js sbc \
     /path/to/data \
     --employee="<employee's email="" name|employee's="" address="">" \
     --date-from="[dd/][mm/]yyyy" \
</employee's></employee's></employee's></employee's></employee's></employee's></employee's>

User Guide modified by Cheng JIANG

Cheng JIANG — Sun, 30 Dec 2018 17:12:32 -0000

--- v1
+++ v2
@@ -1,3 +1,6 @@
+Welcome to the wiki of **Sky**, here is the user guide!
+
+
 ## Usage

 1. Load emails of specific period

User Guide modified by Cheng JIANG

Cheng JIANG — Sat, 29 Dec 2018 23:09:43 -0000

Usage

Load emails of specific period

src/index.js lms \
    /path/to/data \ 
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Show exchanged emails of an employee

src/index.js nms \
    /path/to/data \
    <employee's name  | employee's email address> \ 
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Show busy days of an employee

src/index.js bsd \
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Show the top 10 contacts of an employee

src/index.js tpc \
    /path/to/data \
    <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Show the top 10 words used by an employee in his email subject

src/index.js tpw \ 
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Visualize sent and received emails of an employee

src/index.js emp \
    /path/to/data <employee's name | employee's email address> \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Visualize sent emails of all collaborators

src/index.js nbmc \
    /path/to/data \
    --file="/path/to/save/svg/or/png" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Visualize employee's frequency of sending emails

src/index.js fmu \
    /path/to/data \
    --file="/path/to/save/svg/or/png" \
    --employee="<employee's name|employee's email address>" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy"

Search emails by name of employee or email's content and subject

src/index.js sbc \
    /path/to/data \
    --employee="<employee's name|employee's email address>" \
    --date-from="[dd/][mm/]yyyy" \
    --date-to="[dd/][mm/]yyyy" \
    --subject="text" \
    --content="text"