From 1b81c6073505fd9cade1c3048e00b0b2f9e9bfeb Mon Sep 17 00:00:00 2001 From: kinoshitakenta Date: Mon, 18 Aug 2025 13:33:01 +0800 Subject: [PATCH] docs: update README documentation Adds a README file to describe the project, including instructions on how to configure and run the application, and explains the project's purpose. --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 78c02df..9e424b9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,48 @@ # auto_login_EIP -- 執行 +太常要訂便當了,所以寫個自動登入 EIP 的東西 +省的每次都要找 EIP 的網址是什麼 + +## env + +* Python +* uv +* 剩下的 uv 會幫你裝 + +## repository structure + +```text +./auto_login_EIP/ +├── main.py # main file +├── config.toml # config file +│ +├── pyproject.toml +├── .gitignore +└── README.md +``` + +## usage + +### 配置 + +在 `config.toml` 設定好登入資訊,如果員工 ID 與密碼留空則會在登入時詢問你 +專案路徑下有一個 `config.toml.example` 提供作為修改模板 + +### 執行 ```shell -# uv run python main.py --config_path .\config.toml.example +# uv run python main.py ``` + +或指定 config 檔 + +```shell +# uv run python main.py --config_path .\YOUR_CONFIG.toml +``` + +--- + +如果要酷一點的話串個 Windows 工作排程器或 Linux crontab +這樣每天早上就會自動幫你把 EIP 開起來,就能當個認真的模範打工仔了 + +我要繼續去 coding ㄌ,各位88