docs: add MIT license and update project docs
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 MH Hung
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
@@ -90,6 +90,9 @@ clang-tidy -quiet src/app/main.cpp -- -Iinclude
|
||||
## 工具安裝
|
||||
`make install` 會檢查是否能找到 `clang-format` 與 `clang-tidy`。若缺少任何一項且系統支援 `apt-get`,會嘗試以 `sudo apt-get update` 與 `sudo apt-get install -y` 安裝所需套件(若沒有 `sudo` 則直接呼叫 `apt-get`)。若環境沒有 `apt-get`,指令會提示手動安裝缺少的工具。
|
||||
|
||||
## 授權
|
||||
此專案使用 [MIT License](LICENSE)。
|
||||
|
||||
## 下一步
|
||||
- 在 `src/` 新增更多檔案與模組。
|
||||
- 依專案需求擴充 Makefile 或 utils 腳本。
|
||||
|
Reference in New Issue
Block a user