diff --git a/README.md b/README.md index 094be25..59eba39 100644 --- 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 index 14a2eec..948c8dc 100644 --- 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 index c3a5eff..41de644 100644 --- 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