Browse Source

Minor documentation changes

Summary
-	Modified README.md and README-zh-HK.md in the root folder.
	-	Added headings for Manual installation section
	-	Changed words and phrases for certain sentences
	-	Added bash syntax highlighting for code blocks
Kolton Ko 4 years ago
parent
commit
a597c6500e
2 changed files with 171 additions and 133 deletions
  1. 79 63
      README-zh-HK.md
  2. 92 70
      README.md

+ 79 - 63
README-zh-HK.md

@@ -3,13 +3,13 @@
 <img src="https://img.shields.io/badge/License-Partially%20Open%20Source-blue"> <img src="https://img.shields.io/badge/Build-Community-brightgreen"> <img src="https://img.shields.io/badge/Device-Raspberry%20Pi%203B%2B%20%2F%204B-red"> <img src="https://img.shields.io/badge/Made%20In-Hong%20Kong-blueviolet">
 
 # ArOZ Online 系統 / aCloud
-設計給 Raspberry Pi 3B + 或 4B 的網頁桌面環境個人雲平台。可以用作雲音樂和影片流,數據存儲,簡易辦公/文書處理,3D列印文件預覽,雲編程IDE等等喔!
+為 Raspberry Pi 3B + 或 4B 裝置度身訂造的網頁桌面環境個人雲平台。可以用作雲音樂和影片流,數據存儲,簡易辦公/文書處理,3D列印文件預覽,雲編程IDE等等喔!
 
 ## 快速開始
-本說明將向您展示如何在自己的Raspberry Pi或其他單片電腦的 Linux上安裝ArOZ Online系統。
+本說明將向您展示如何在自己的Raspberry Pi或其他運行 Linux 的單晶片電腦上安裝ArOZ Online系統。
 
 ### 系統要求
-要在Linux系統上運行該系統,需要以下軟件包
+運行本系統需要安裝以下軟體
 - apache2
 - libapache2-mod-xsendfile
 - php libapache2-mod-php php-cli php-common php-mbstring php-gd php xml php-zip
@@ -18,93 +18,112 @@
 - samba (可選)
 
 要安裝以上軟件包,請逐行複製以下行並將其貼上到ssh終端內。
-```
-#Add the following line if you are using a fresh install of Debian Buster
+```bash
+# 如果您使用新安裝的 Debian Buster 系統,請執行以下指令以安裝所需軟體。
 sudo apt-get install unzip net-tools ntfs-3g -y
 sudo apt-get update
 sudo apt-get install -y apache2
 sudo apt-get install -y php libapache2-mod-php php-cli php-common php-mbstring php-gd php xml php-zip 
 sudo apt-get install libapache2-mod-xsendfile
-#The lines below are optional. But it is recommended to install them for future uses
+# 以下指令安裝可選的軟體套件,並非必要,但安裝後能對將來更多用戶提供更好體驗。
 sudo apt-get install php-mysql
-#Use libav-tools instead of ffmpeg if you are still using Debian Jessie
+# 如果您的Debian版本仍為 Debian Jessie ,請以 libav-tools 取代 ffmpeg
 sudo apt-get install ffmpeg
 sudo apt-get install samba
 ```
 ### 預建映像檔案
 要將ArOZ Online System安裝到Raspberry pi,您可以使用Raspberry Pi 4B / 3B +的預構建映像檔案。您可以在下面的網址中找到該映像檔:
 
-還沒準備好喔!
+> 還沒準備好喔!
 
 ### 手動安裝
-ArOZ Online 系統已經過測試可安裝在Debian Jessie和Debian Buster上。在安裝ArOZ Online 系統之前,您需要先行調整設定。
 
-1. 編輯 php.ini以增加最大文件上傳大小設置。 php.ini文件通常可以在 /etc/php/{php-version}/apache2/php.ini 找到. 如下所示的更改這兩行:
-  ```
-  upload_max_filesize = 2048M
-  post_max_size = 2048M
-  ```
-  
-2. 如果你對 Linux 權限設定不太熟悉,你可以直接使用 nano 打開 /etc/sudoers,並在檔案底部加上以下一行
-  ```
-  www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip
-  ```
-  **(此行只限於個人於內聯網中使用。如果你打算把此系統開放到互聯網,請自行根據下面的提示進行設定)**
-  
-  
-  充許使用者透過 ArOZ Online 系統載入及移除外置儲存裝置
-  ```
-  www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
-  ```
-  
-  充許使用者透過網頁界面關閉、重啟伺服器
-  ```
-  www-data ALL=NOPASSWD: /sbin/halt, /sbin/reboot, /sbin/poweroff
-  ```
-  
-  充許 ArOZ Online 系統取得網絡及 WiFi 設定
+#### 概覽
+
+ArOZ Online 支援 Debian Jessie 和 Debian Buster 作為其底系統。在安裝ArOZ Online 系統之前,請先安裝[所需軟體套件](#系統要求)。
+
+#### 設定PHP
+
+ArOZ Online 不支援預設的 PHP 設定。
+
+更改 php.ini 的內容以增加最大文件上傳大小設定。在 Debian 系統中,`php.ini` 文件通常可以在 `/etc/php/{php-version}/apache2/php.ini` 找到。請依照以下來更改 `php.ini` 中的設定值。
+
   ```
-  www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
+upload_max_filesize = 2048M
+post_max_size = 2048M
   ```
-  
-  充許 ArOZ Online 系統新建新的檔案系統,包括 vfat 及 ntfs
+
+#### 設定權限
+
+部分功能需要特別的權限設定才能啟用。
+
+如果你對 Linux 權限設定不太熟悉,你可以直接使用 `nano` 打開 `/etc/sudoers`,並在檔案尾端加上以下一行。
+
   ```
-  www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
+www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip
   ```
+  **(此行只限於個人內聯網中使用。如果你打算把此系統開放到互聯網,請自行根據下面的提示進行設定。)**
+
+- 允許使用者透過 ArOZ Online 系統載入及移除外置儲存裝置
+
+      www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
   
-  TO BE ADDED
+- 允許使用者透過網頁界面關閉、重啟伺服器
+
+      www-data ALL=NOPASSWD: /sbin/halt, /sbin/reboot, /sbin/poweroff
   
-3. 編輯 /etc/apache2/apache2.conf, 在檔案底部加上這兩行:
-  ```
-  XSendFile on
-  XSendFilePath /media
-  ```
+- 允許 ArOZ Online 系統存取網絡及 WiFi 設定
+
+      www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
   
-4. 在 /media/storage1 和 /media/storage2 新建兩個資料夾
-  ```
-  sudo mkdir /media/storage1 /media/storage2
+- 允許 ArOZ Online 系統建立新的 NTFS 或 FAT32 檔案系統
+
+      www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
+
+> TO BE ADDED
+
+#### Apache 設定
+
+編輯 `/etc/apache2/apache2.conf`文件,在檔案尾端部加入以下兩行。
+
   ```
-接下來,您需要下載ArOZ在線系統並將其安裝到您的webroot(/ var / www / html /)。
-為此,您可以使用以下命令移動到網絡伺服器的根目錄:
+XSendFile on
+XSendFilePath /media
   ```
-  cd /var/www/html/
+
+#### 建立目錄
+
+在 `/media/storage1` 和 `/media/storage2` 新建兩個目錄。
+
+  ```bash
+sudo mkdir /media/storage1 /media/storage2
   ```
+#### 安裝 ArOZ Online 至網頁伺服器
 
-然後以 zip格式下載此源碼庫,將 "src" 文件夾解壓縮到 /var/www/html 然後將 "src" 命名為 "AOB"。
-如果你是在使用 Windows 作業系統,你可以下載並使用 WinSCP 來進行此操作. 否則,您可以使用git clone命令,類似於下面的示例。在使用git命令之前,請確保已安裝 git 軟件。如果你還沒安裝你可以用 ```sudo apt-get install git``` 來進行安裝。
+您需要下載ArOZ Online 系統並將其安裝到您網頁伺服器的根目錄(`/var/www/html/`)
+您可以使用以下命令移動到網頁伺服器的根目錄
 
+  ```bash
+cd /var/www/html/
   ```
-  git clone https://github.com/tobychui/ArOZ-Online-System/
-  sudo mv ArOZ-Online-System/src ./AOB
-  sudo rm -rf ./ArOZ-Online-System
+
+然後以 zip 格式下載此源碼庫,將 `src` 文件夾解壓縮至 `/var/www/html` 然後將 `src`目錄更名為 `AOB`。
+在 Windows 作業系統中,您可以下載並使用 WinSCP 來進行此操作。否則,您可以使用 `git clone` 指令,可參考於下面的示例。在使用 `git` 命令之前,請確保已安裝 `git` 軟體。您可以執行 ```sudo apt-get install git``` 以安裝之。
+
+  ```bash
+git clone https://github.com/tobychui/ArOZ-Online-System/
+sudo mv ArOZ-Online-System/src ./AOB
+sudo rm -rf ./ArOZ-Online-System
   
-  sudo mkdir -p "/etc/AOB"
-  sudo chmod 777 -R "/etc/AOB"
-  sudo chmod 777 -R ./AOB
-  sudo chown -R www-data ./
+sudo mkdir -p "/etc/AOB"
+sudo chmod 777 -R "/etc/AOB"
+sudo chmod 777 -R ./AOB
+sudo chown -R www-data ./
   ```
-  
-  使用你喜歡的瀏覽器打開: http://{Raspberry_Pi_IP_Address}/AOB/ 然後跟據屏幕上的指南設置新用戶。
+
+#### 首次登入
+
+使用你喜歡的瀏覽器打開:`http://{Raspberry_Pi_IP_Address}/AOB/`,然後跟據網頁上的指示建立新用戶。
 
 ## 系統截圖
 ![Image](img/screenshots/audio.png?raw=true)
@@ -163,6 +182,3 @@ TocasUI by Yami Odymel - https://tocas-ui.com/
 
 ## 支持本系統開發
 如果您真的想給我一些東西,歡迎隨時與我聯絡 :)
-
-
-

+ 92 - 70
README.md

@@ -5,12 +5,12 @@
 [中文說明](README-zh-HK.md)
 
 # ArOZ Online System / aCloud
-Personal Cloud Platform with Web Desktop Environment for Raspberry Pi 3B+ or 4B. A place to start cloud music and video streaming, data storage, office work / text processing, 3D printing file previews, Cloud programming IDE and more!
+Personal Cloud Platform with Web Desktop Environment for Raspberry Pi 3B+ or 4B. A place to start cloud music and video streaming, data storage, lightweight office work / text processing, 3D printing file previews, Cloud programming IDE and more!
 
 **WARNING! THIS SYSTEM IS STILL IN BETA PHRASE.**
 
 ## Getting Started
-These instructions will show you how to deploy a copy of ArOZ Online System on your own Raspberry Pi or other low power, Linux running SBCs for community review and testing purposes. Read more on the [Full System Documentation](https://tobychui.github.io/ArOZ-Online-System/).
+These instructions will guide you through the deployment of a copy of ArOZ Online System on your own Raspberry Pi or other low power, Linux running SBCs for community review and testing purposes. Read more on the [Full System Documentation](https://tobychui.github.io/ArOZ-Online-System/).
 
 ### Docker
 Follow the instruction from this repo: https://github.com/Saren-Arterius/aroz-dockerize
@@ -25,94 +25,117 @@ The following packages are required for the system to run on your Linux system.
 - samba (Optional)
 
 To install the package above, copy and paste the following lines into your ssh terminal line by line.
-```
-#Add the following line if you are using a fresh install of Debian Buster
+```bash
+# Add the following line if you are using a fresh install of Debian Buster
 sudo apt-get install unzip net-tools ntfs-3g dosfstools -y
 sudo apt-get update
 sudo apt-get install -y apache2
 sudo apt-get install -y php libapache2-mod-php php-cli php-common php-mbstring php-gd php-xml php-zip 
 sudo apt-get install libapache2-mod-xsendfile
-#The lines below are optional. But it is recommended to install them for future uses
+# The lines below are optional. But it is recommended to install them for future uses
 sudo apt-get install php-mysql
-#Use libav-tools instead of ffmpeg if you are still using Debian Jessie
+# Use libav-tools instead of ffmpeg if you are still using Debian Jessie
 sudo apt-get install ffmpeg
 sudo apt-get install samba
 ```
 ### Prebuilt Image File
 To install ArOZ Online System to your Raspberry pi, you can use the prebuilt image file for Raspberry Pi 4B / 3B+. You can find the image in the link below:
 
-WORK IN PROGRESS
+> WORK IN PROGRESS
 
 ### Manual Installation
-ArOZ Online System is only tested to install on Debian Jessie and Debian Buster. Before installing the ArOZ Online System, you need to firstly setup the package settings. 
 
-1. Edit php.ini to increase the max file upload size setting. The php.ini file can usually be found in /etc/php/{php-version}/apache2/php.ini. Change the two lines below as follows:
-  ```
-  upload_max_filesize = 2048M
-  post_max_size = 2048M
-  ```
-  
-2. If you are a noob and don't want to mess around with the sudoer settings, just edit /etc/sudoers, add the following line at the bottom of the file.
-  ```
-  www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g,  /usr/bin/ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip, /sbin/mkfs.ntfs, /sbin/mkfs.vfat
-  ```
-  **(Only if you are using the system in local area network. Please adjust this to suit your needs if you are planning to access the system through the internet.)**
-  
-  If you are pros and want to have much better control of the system security, add the lines that fits your need according to the selections below.
-  
-  Allow system to mount and unmount USB drives of your Raspberry Pi
-  ```
-  www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
-  ```
+#### Overview
+
+ArOZ Online System is only tested on Debian Jessie and Debian Buster. Before installing the ArOZ Online System, you need to install necessary software package as shown in the [Prerequisites](#Prerequisites) section. 
+
+#### Configuring PHP
+
+ArOZ Online is not compatiable with the default PHP settings.
+
+Edit `php.ini` to increase the max file upload size setting. On Debian systems, the `php.ini` file can usually be found in `/etc/php/{php-version}/apache2/php.ini`. Change these two lines below as follows:
+```
+upload_max_filesize = 2048M
+post_max_size = 2048M
+```
+
+#### Configuring Permissions
+
+Certain features of ArOZ Online System requires explicit authorization through configuration files.
+
+If you are not familiar with `sudoer` configuration syntax, open `/etc/sudoers` with `nano` and add the following to the end of file.
+
+```
+www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g,  /usr/bin/ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip, /sbin/mkfs.ntfs, /sbin/mkfs.vfat
+```
+**(Use the above settings only if you are hosting the system in your local area network. Please adjust this to suit your needs if you are allowing the access of the system from the internet.)**
+
+If you are familiar and want to have much better control of the system security, add the lines that fits your need according to the selections below.
+
+- Allow the system to mount and unmount your USB drives
+
+      www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
   
-  Allow system to be powered off via the Web UI
+- Allow system to be powered off via the Web UI
+
   ```
   www-data ALL=NOPASSWD: /sbin/halt, /sbin/reboot, /sbin/poweroff
   ```
-  
-  Allow system to access local area network IP address and WiFi network settings
-  ```
-  www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
-  ```
-  
-  Allow system to format and create new partitions
-  ```
-  www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
-  ```
-  
-  TO BE ADDED
-  
-3. Edit /etc/apache2/apache2.conf, add the following two lines to the bottom of the file
-  ```
-  XSendFile on
-  XSendFilePath /media
-  ```
-  
-4. Create directory at /media/storage1 and /media/storage2
-  ```
-  sudo mkdir /media/storage1 /media/storage2
+
+- Allow system to access local area network IP address and WiFi network settings
+    ```
+    www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
+    ```
+
+- Allow system to format and erase partitions
+    ```
+    www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
+    ```
+
+> TO BE ADDED
+
+#### Apache Settings
+
+Edit `/etc/apache2/apache2.conf`, add the following two lines to the end of file
+
   ```
-Next, you need to download and install the ArOZ Online System to your webroot (/var/www/html/).
-To do so, you can firsly move into the web root with the following command:
+XSendFile on
+XSendFilePath /media
   ```
-  cd /var/www/html/
+
+#### Creating directories
+
+Create directory at /media/storage1 and /media/storage2
+
+  ```bash
+sudo mkdir /media/storage1 /media/storage2
   ```
+#### Installing ArOZ Online to webroot directory
 
-And then download the repo as zip, unzip the "src" folder into /var/www/html and ename "src" to "AOB".
-You can do this with WinSCP if you are using windows. Or otherwise, you can use git clone command similar to the example below. Make sure you have installed git using ```sudo apt-get install git``` before using the git commands.
+You will need to download and install the ArOZ Online System to your webroot (`/var/www/html/`).
+Navigate into the web root using the following command
 
+  ```bash
+cd /var/www/html/
   ```
-  git clone https://github.com/tobychui/ArOZ-Online-System/
-  sudo mv ArOZ-Online-System/src ./AOB
-  sudo rm -rf ./ArOZ-Online-System
+
+And then download the repo as zip, unzip the `src` folder into `/var/www/html` and rename `src` to `AOB`.
+You can do this using WinSCP if you on Windows. Otherwise, you can use `git clone` command similar to the example below. Make sure you have installed `git` using ```sudo apt-get install git``` before running `git` command.
+
+  ```bash
+git clone https://github.com/tobychui/ArOZ-Online-System/
+sudo mv ArOZ-Online-System/src ./AOB
+sudo rm -rf ./ArOZ-Online-System
   
-  sudo mkdir -p "/etc/AOB"
-  sudo chmod 777 -R "/etc/AOB"
-  sudo chmod 777 -R ./AOB
-  sudo chown -R www-data ./
+sudo mkdir -p "/etc/AOB"
+sudo chmod 777 -R "/etc/AOB"
+sudo chmod 777 -R ./AOB
+sudo chown -R www-data ./
   ```
-  
-  Open your default browser and visit the http://{Raspberry_Pi_IP_Address}/AOB/ and follow the on scren guide for setting up a new user.
+
+#### Testing
+
+Open your default browser and visit the http://{Raspberry_Pi_IP_Address}/AOB/ and follow the on scren guide for setting up a new user.
 
 ## Preview / Screenshots
 ![Image](img/screenshots/audio.png?raw=true)
@@ -123,6 +146,7 @@ You can do this with WinSCP if you are using windows. Or otherwise, you can use
 ![Image](img/screenshots/async-fileopr.png?raw=true)
 ![Image](img/screenshots/diskman.png?raw=true)
 ![Image](img/screenshots/settings.png?raw=true)
+
 Click <a href="https://github.com/tobychui/ArOZ-Online-System/tree/master/img/screenshots">here</a> for more preview screenshots
 
 ## Versioning
@@ -134,15 +158,15 @@ Different major change in versioning will lead to an upgrade to the codename. He
 | Before Beta 1.2.8     | Sempervivum Tectorum     | N/A          | Full                         |
 | Beta 12-06-2019       | aCloud                   | Init Release | Pre-release                  |
 
-*Full versions are only disclose to internal developers or testers for review purpose only.
+*Full versions are only available for internal developers or testers for testing purposes only.
 
 ## Author
-### Developer
+### Developers
 (Blame them if you encounter any bugs within the system)
 * tobychui - Project initiator / System Developer / Core Modules designer and programmer
 * <a href="https://github.com/yeungalan">yeungalan</a> - Module maintainer / Network Setting Module developer
 
-### Beta Tester
+### Beta Testers
 (Find them if you want to know how to use a specific function in the system)
 * <a href="https://github.com/aceisace">aceisace</a>
 * <a href="https://github.com/RubMing">RubMing</a>
@@ -173,7 +197,5 @@ Threejs by Mrdoob - https://threejs.org/
 TO BE ADDED
 
 ## Buy me a coffee
-Actually I don't drink coffee. Send me something that would make me feel interested if you really want to send me something :)
-
-
-
+Actually I don't drink coffee.
+Send me something that would make me feel interested if you really want to send me something :)