update to v1.2.11

Author: cg33

README.md

@@ -3,6 +3,8 @@
 - [adminlte](https://github.com/GoAdminGroup/themes/tree/master/adminlte)
 - [sword](https://github.com/GoAdminGroup/themes/tree/master/sword)
 
+[中文介绍](./README_CN.md)
+
 ## How to use
 
 - Import the theme

README_CN.md

@@ -0,0 +1,41 @@
+# GoAdmin 官方主题
+
+- [adminlte](https://github.com/GoAdminGroup/themes/tree/master/adminlte)
+- [sword](https://github.com/GoAdminGroup/themes/tree/master/sword)
+
+## 如何使用
+
+- 导入主题
+- 在全局配置中设置
+
+```go
+
+package main
+
+import (
+	...
+	_ "github.com/GoAdminGroup/themes/adminlte"
+	...
+)
+
+func main()  {
+	
+	...
+	
+	cfg := config.Config{
+    		...
+    		
+    		Theme: "adminlte",
+    		
+    		...
+    	}
+	
+	...
+ 
+}
+
+```
+
+## 如何修改，自定义
+
+使用每个主题下面的 Makefile 命令

adminlte/Makefile

@@ -2,10 +2,15 @@ CLI=adm
 RESOURCE_PATH=./resource
 ASSETS_PATH=./resource/assets
 
-all: assets
+all: build
 
-assets:
-	find ./ -name ".DS_Store" -depth -exec rm {} \;
+# build a theme
+# 构建主题
+build: rebuild-dist combine build-assets build-tmpl clean fmt
+
+# clean old dist folder, create new dist folder.
+# 删除旧的dist文件夹，新建新的dist文件夹
+rebuild-dist:
 	rm -rf $(ASSETS_PATH)/dist
 	mkdir $(ASSETS_PATH)/dist
 	mkdir $(ASSETS_PATH)/dist/js
@@ -14,28 +19,16 @@ assets:
 	cp $(RESOURCE_PATH)/adminlte/adminlte.css $(ASSETS_PATH)/src/css/combine/g_all.css
 	cp $(ASSETS_PATH)/src/js/*.js $(ASSETS_PATH)/dist/js/
 	cp $(ASSETS_PATH)/src/css/*.png $(ASSETS_PATH)/dist/css/
-
 	cp -R ./../common/pages/* $(RESOURCE_PATH)/pages/
 
 	cp -R $(ASSETS_PATH)/src/css/fonts $(ASSETS_PATH)/dist/css/
 	cp -R $(ASSETS_PATH)/src/img $(ASSETS_PATH)/dist/
-	cp -R $(ASSETS_PATH)/src/fonts $(ASSETS_PATH)/dist/
-	make combine
-	$(CLI) compile asset
-	packr2 clean
-	packr2
-	make build-tmpl
-
-	rm -rf $(ASSETS_PATH)/src/*
-	rm -rf $(RESOURCE_PATH)/pages/*
-
-	GO111MODULE=off go fmt ./...
+	cp -R $(ASSETS_PATH)/src/fonts $(ASSETS_PATH)/dist/	
 
+# combine frontend assets(js/css)
+# 合并并压缩前端js/css
 combine: remove combine-js combine-css
 
-remove:
-	find ./ -name ".DS_Store" -depth -exec rm {} \;
-
 combine-js:
 	$(CLI) combine js --hash=true --src=$(ASSETS_PATH)/src/js/all/ --dist=$(ASSETS_PATH)/dist/js/all.min.js
 	$(CLI) combine js --hash=true --src=$(ASSETS_PATH)/src/js/all_2/ --dist=$(ASSETS_PATH)/dist/js/all_2.min.js
@@ -47,5 +40,33 @@ combine-js:
 combine-css:
 	$(CLI) combine css --hash=true
 
+# use packr2 turn assets into a go file.
+# 使用packr2工具将css/js等前端资源合并为一个go文件
+# more: https://github.com/gobuffalo/packr
+build-assets:
+	$(CLI) compile asset
+	packr2 clean
+	packr2
+
+# turn golang template files into a go file.
+# 将所有golang模板文件(.tmpl)合并为一个golang文件
 build-tmpl:
-	$(CLI) compile tpl -p=adminlte
+	$(CLI) compile tpl -p=adminlte
+
+# clean
+# 整理生成后的文件夹
+clean:
+	rm -rf $(ASSETS_PATH)/src/*
+	rm -rf $(RESOURCE_PATH)/pages/*
+
+# go fmt
+# 对生成的go文件进行格式化
+fmt:
+	GO111MODULE=off go fmt ./...
+
+# remove useless system files.
+# 删除系统产生的无用文件，防止被一并合并到golang文件中
+remove:
+	find ./ -name ".DS_Store" -depth -exec rm {} \;
+
+.PHONY: all build rebuild-dist combine combine-js combine-css build-assets build-tmpl clean fmt remove

sword/Makefile

@@ -2,11 +2,15 @@ CLI=adm
 RESOURCE_PATH=./resource
 ASSETS_PATH=./resource/assets
 
-all: assets
+all: build
 
-# generate assets dist
-assets:
-	find ./ -name ".DS_Store" -depth -exec rm {} \;
+# build a theme
+# 构建主题
+build: rebuild-dist combine build-assets build-tmpl clean fmt
+
+# clean old dist folder, create new dist folder.
+# 删除旧的dist文件夹，新建新的dist文件夹
+rebuild-dist:
 	rm -rf $(ASSETS_PATH)/dist
 	mkdir $(ASSETS_PATH)/dist
 	mkdir $(ASSETS_PATH)/dist/js
@@ -28,22 +32,10 @@ assets:
 	cp -R $(ASSETS_PATH)/src/img $(ASSETS_PATH)/dist/
 	cp -R $(ASSETS_PATH)/src/fonts $(ASSETS_PATH)/dist/
 
-	make combine
-	$(CLI) compile asset
-	packr2 clean
-	packr2
-	make build-tmpl
-
-	rm -rf $(ASSETS_PATH)/src/*
-	rm -rf $(RESOURCE_PATH)/pages/*
-
-	GO111MODULE=off go fmt ./...
-
+# combine frontend assets(js/css)
+# 合并并压缩前端js/css
 combine: remove combine-js combine-css
 
-remove:
-	find ./ -name ".DS_Store" -depth -exec rm {} \;	
-
 combine-js:
 	$(CLI) combine js --hash=true --src=$(ASSETS_PATH)/src/js/all/ --dist=$(ASSETS_PATH)/dist/js/all.min.js
 	$(CLI) combine js --hash=true --src=$(ASSETS_PATH)/src/js/all_2/ --dist=$(ASSETS_PATH)/dist/js/all_2.min.js
@@ -55,6 +47,33 @@ combine-js:
 combine-css:
 	$(CLI) combine css --hash=true
 
-# generate golang template file
+# use packr2 turn assets into a go file.
+# 使用packr2工具将css/js等前端资源合并为一个go文件
+# more: https://github.com/gobuffalo/packr
+build-assets:
+	$(CLI) compile asset
+	packr2 clean
+	packr2
+
+# turn golang template files into a go file.
+# 将所有golang模板文件(.tmpl)合并为一个golang文件
 build-tmpl:
 	$(CLI) compile tpl -p=sword
+
+# clean
+# 整理生成后的文件夹
+clean:
+	rm -rf $(ASSETS_PATH)/src/*
+	rm -rf $(RESOURCE_PATH)/pages/*
+
+# go fmt
+# 对生成的go文件进行格式化
+fmt:
+	GO111MODULE=off go fmt ./...
+
+# remove useless system files.
+# 删除系统产生的无用文件，防止被一并合并到golang文件中
+remove:
+	find ./ -name ".DS_Store" -depth -exec rm {} \;
+
+.PHONY: all build rebuild-dist combine combine-js combine-css build-assets build-tmpl clean fmt remove