update README

Signed-off-by: zhaojh329 <[email protected]>
taotaobeta · Jun 9, 2017 · c6677be · c6677be
1 parent b5f8b2b
commit c6677be
Show file tree

Hide file tree

Showing 21 changed files with 163 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,55 @@
-#luci2
+# xLuCI2([中文](https://github.com/zhaojh329/xluci2/blob/master/README_ZH.md))
+
+![](https://img.shields.io/badge/license-GPLV3-brightgreen.svg?style=plastic "License")
+
+xLuCI2 is a JavaScript Webgui for embedded devices running OpenWRT or LEDE. xLuCI2 based on original [LuCI2](https://wiki.openwrt.org/doc/techref/luci2), 
+fix a large number of bug on the basis of the original LuCI2, and added some features: dynamic skin, dynamic switching language, modularization.
+
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo1.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo2.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo3.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo4.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo5.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo6.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo7.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo8.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo9.png)
+
+# Features
+* Based on bootstrap framework(You can write beautiful pages)
+* The front end is communicated with the background through UBUS
+* Dynamic skin
+* Dynamic switching language
+* Multi user rights management(read only, invisible, writable)
+
+# Usage on OpenWRT/LEDE
+
+	# go to your OpenWRT/LEDE directory
+	cd openwrt
+
+	# add xLuCI2 feed to feeds conf
+	echo "src-git xluci2 https://github.com/zhaojh329/xluci2.git" >> feeds.conf.default
+
+	# update your feeds
+	./scripts/feeds update -a 
+
+	# install all xluci2 packages
+	./scripts/feeds install -a -p xluci2
+
+	# select xluci2 packages
+	make menuconfig
+	LuCI2  --->
+		Applications  --->
+		Themes  --->
+		<*> luci2-base
+
+	# compile
+	make V=s
+
+# How To Contribute
+Feel free to create issues or pull-requests if you have any problems.
+
+**Please read [contributing.md](https://github.com/zhaojh329/xluci2/blob/master/contributing.md)
+before pushing any changes.**
+
+# If the project is helpful to you, please do not hesitate to star. Thank you!
diff --git a/README_ZH.md b/README_ZH.md
@@ -0,0 +1,63 @@
+# xLuCI2
+
+![](https://img.shields.io/badge/license-GPLV3-brightgreen.svg?style=plastic "License")
+
+xLuCI2基于原LuCI2，修复大量bug，新增动态换肤和动态语言切换。
+
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh1.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh2.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh3.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh4.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh5.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh6.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh7.png)
+![](https://github.com/zhaojh329/xluci2/blob/master/image/demo_zh8.png)
+
+# 特性
+* 基于bootstrap框架
+* 前端通过调用后台注册的ubus进行数据交互
+* 动态换肤
+* 动态语言切换
+* 多用户权限控制(只读、可写、不可见)
+
+# 使用方法
+
+	# go to your OpenWRT/LEDE directory
+	cd openwrt
+
+	# add xLuCI2 feed to feeds conf
+	echo "src-git xluci2 https://github.com/zhaojh329/xluci2.git" >> feeds.conf.default
+
+	# update your feeds
+	./scripts/feeds update -a 
+
+	# install all xluci2 packages
+	./scripts/feeds install -a -p xluci2
+
+	# select xluci2 packages
+	make menuconfig
+	LuCI2  --->
+		Applications  --->
+		Themes  --->
+		<*> luci2-base
+
+	# compile
+	make V=s
+
+# 贡献代码
+
+xLuCI2使用github托管其源代码，贡献代码使用github的PR(Pull Request)的流程，十分的强大与便利:
+
+1. [创建 Issue](https://github.com/zhaojh329/xluci2/issues/new) - 对于较大的
+	改动(如新功能，大型重构等)最好先开issue讨论一下，较小的improvement(如文档改进，bugfix等)直接发PR即可
+2. Fork [xluci2](https://github.com/zhaojh329/xluci2) - 点击右上角**Fork**按钮
+3. Clone你自己的fork: ```git clone https://github.com/$userid/xluci2.git```
+4. 创建dev分支，在**dev**修改并将修改push到你的fork上
+5. 创建从你的fork的**dev**分支到主项目的**dev**分支的[Pull Request] -  
+	[在此](https://github.com/zhaojh329/xluci2)点击**Compare & pull request**
+6. 等待review, 需要继续改进，或者被Merge!
+
+# 技术交流
+QQ群：153530783
+
+# 如果该项目对您有帮助，请随手star，谢谢！
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1,42 @@
+Contributing
+================================================================================
+
+If you want to contribute to [xluci2](https://github.com/zhaojh329/xluci2), please follow these simple rules:
+
+1. Press the fork button:
+
+    ![fork](http://oi58.tinypic.com/jj2trm.jpg)
+
+2. Clone the repository from your account with:
+
+    ```
+    git clone [email protected]:your_github_username/xluci2.git
+    ```
+
+3. Create a new branch with:
+
+    ```
+    git checkout -b "xluci2-1-fix"
+    ```
+    You can name it however you want.
+
+4. Make your changes
+
+5. Don't forget to add yourself in `contributors.md`.
+
+6. Commit and push your changes, then make a pull request from Github.
+
+    git commit --signoff  
+    git push
+    
+7. Awaiting review, if accepted, merged!
+
+**IMPORTANT**
+
+Please, don't forget to update your fork. While you made your changes, 
+the content of the `master` branch can change because other pull requests 
+were merged and it can create conflicts. This is why you have to rebase 
+on `master` every time before pushing your changes and check that your 
+branch doesn't have any conflicts with `master`.
+
+Thank you.
diff --git a/contributors.md b/contributors.md
@@ -0,0 +1,3 @@
+Thank you to all contributors:
+------------------------------
+[zhaojh](https://github.com/zhaojh329)
diff --git a/image/demo1.png b/image/demo1.png
diff --git a/image/demo2.png b/image/demo2.png
diff --git a/image/demo3.png b/image/demo3.png
diff --git a/image/demo4.png b/image/demo4.png
diff --git a/image/demo5.png b/image/demo5.png
diff --git a/image/demo6.png b/image/demo6.png
diff --git a/image/demo7.png b/image/demo7.png
diff --git a/image/demo8.png b/image/demo8.png
diff --git a/image/demo9.png b/image/demo9.png
diff --git a/image/demo_zh1.png b/image/demo_zh1.png
diff --git a/image/demo_zh2.png b/image/demo_zh2.png
diff --git a/image/demo_zh3.png b/image/demo_zh3.png
diff --git a/image/demo_zh4.png b/image/demo_zh4.png
diff --git a/image/demo_zh5.png b/image/demo_zh5.png
diff --git a/image/demo_zh6.png b/image/demo_zh6.png
diff --git a/image/demo_zh7.png b/image/demo_zh7.png
diff --git a/image/demo_zh8.png b/image/demo_zh8.png