chore: update

better-sre · Jul 6, 2024 · ff81dd6 · ff81dd6
1 parent b90250d
commit ff81dd6
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -6,78 +6,37 @@
 - Automatically supports `cross-platform` installation.
 - Thanks to the [go-task](https://github.com/go-task/task) project.
 
-## QuickStart:
+> included:
 
-### 1. Setup:
+- `docker-compose`
+- `dockerfile`
+- `Taskfile`
 
-> MacOS/Linux:
+## Manual:
 
-- auto check `go-task`, if not installed, auto install it.
+- ✅ [Manual](./manual.md)
 
-```ruby
-curl -fsSL https://raw.githubusercontent.com/better-sre/config/main/init.sh | sh
-```
+## Contents:
 
-> Windows+PowerShell:
+### Docker-compose:
 
-```ruby
-
-```
+- ✅ [docker-compose/local](docker-compose/local)
 
-> other usage:
+### Docker + Dockerfile:
 
-- [Manual](./manual.md)
-
-### 2. Include in your Project:
-
-- 🍄 add these content to your `Taskfile.yml` file.
-
-```yml
-includes:
-  # way: global path
-  sre:
-    taskfile: ~/.local/task/better-sre/config/Taskfile.yml # TODO: please create `~/.task/` first before use
-    dir: ~/.local/task/better-sre/config # global path
-    optional: true # safeguard, if not found, no error
-```
+- ✅ [Dockerfile](./dockerfile)
 
-### 3. Usage:
+#### Python + Ubuntu + Dockerfile:
 
-> ❓ Note that when using in your project, you need to use the [sre:]() `prefix` to use the following scripts.
-> like this:
+- ✅ [dockerfile/python](dockerfile/python)
 
 ```ruby
 
-task sre:rust:install
-task sre:go:install
+# build ubuntu + python:3.12
+task df:py:b312
 
-task sre:docker:local:up:mysql
-task sre:docker:local:up:redis
-```
-
-- 😄 enjoy!
-
-## Structure:
-
-- `Directory of files` automatically created by the `installation script`.
-
-```ruby
-
-# PROJECT_PATH="${HOME}/.local/task/better-sre/config"
-
-➤ tree ~/.local/ -L 4
-/Users/XX-USER/.local/
-└── task
-    └── better-sre
-        └── config
-            ├── LICENSE
-            ├── README.md
-            ├── Taskfile.yml
-            ├── docker-compose
-            ├── dockerfile
-            ├── k8s
-            ├── run
-            ├── script
-            └── taskfile
+# test container:
+task df:py:t312
 
 ```
+
diff --git a/README_CN.md b/README_CN.md
@@ -14,13 +14,19 @@
 - `dockerfile`
 - `Taskfile`
 
-## Docker + Dockerfile:
+## Contents:
 
+### Docker-compose:
 
-### Python
+- [docker-compose/local](docker-compose/local)
 
-- [dockerfile/python](dockerfile/python)
+### Docker + Dockerfile:
+
+- [Dockerfile](./dockerfile)
 
+#### Python + Ubuntu + Dockerfile:
+
+- [dockerfile/python](dockerfile/python)
 
 ```ruby
 
@@ -31,4 +37,3 @@ task df:py:b312
 task df:py:t312
 
 ```
-
diff --git a/manual.md b/manual.md
@@ -1,5 +1,8 @@
 # Manual:
 
+
+
+
 ## Setup:
 
 > 🍄 before use, please install [go-task](https://github.com/go-task/task).
@@ -132,6 +135,85 @@ task sre:go:install
 - 部分脚本写了跨平台, 比较少, 如果有兴趣, 欢迎 PR 支持.
 - Taskfile 原生支持跨平台, 改写起来也简单, 只是我没有太多精力, 照顾不到.😄
 
+
+
+## QuickStart:
+
+### 1. Setup:
+
+> MacOS/Linux:
+
+- auto check `go-task`, if not installed, auto install it.
+
+```ruby
+curl -fsSL https://raw.githubusercontent.com/better-sre/config/main/init.sh | sh
+```
+
+> Windows+PowerShell:
+
+```ruby
+
+```
+
+> other usage:
+
+- [Manual](./manual.md)
+
+### 2. Include in your Project:
+
+- 🍄 add these content to your `Taskfile.yml` file.
+
+```yml
+includes:
+  # way: global path
+  sre:
+    taskfile: ~/.local/task/better-sre/config/Taskfile.yml # TODO: please create `~/.task/` first before use
+    dir: ~/.local/task/better-sre/config # global path
+    optional: true # safeguard, if not found, no error
+```
+
+### 3. Usage:
+
+> ❓ Note that when using in your project, you need to use the [sre:]() `prefix` to use the following scripts.
+> like this:
+
+```ruby
+
+task sre:rust:install
+task sre:go:install
+
+task sre:docker:local:up:mysql
+task sre:docker:local:up:redis
+```
+
+- 😄 enjoy!
+
+## Structure:
+
+- `Directory of files` automatically created by the `installation script`.
+
+```ruby
+
+# PROJECT_PATH="${HOME}/.local/task/better-sre/config"
+
+➤ tree ~/.local/ -L 4
+/Users/XX-USER/.local/
+└── task
+    └── better-sre
+        └── config
+            ├── LICENSE
+            ├── README.md
+            ├── Taskfile.yml
+            ├── docker-compose
+            ├── dockerfile
+            ├── k8s
+            ├── run
+            ├── script
+            └── taskfile
+
+```
+
+
 ## Related:
 
 - https://github.com/service-mesh/devops