diff --git a/README.md b/README.md index cce070f..37f6743 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,40 @@ - **Comprehensive error handling** - Detailed error messages with source locations - **Clean C++ implementation** - Modern C++23 with RAII and smart pointers +### 🔧 Install +# Installation + +## Prerequisites +**Xmake** version **3.0.0 or higher** must be installed on your system. + +## Build Instructions + +1. Clone the repository: + +```bash +git clone https://github.com/PuqiAR/Fig.git +``` + +2. Navigate to the project directory: + +```bash +cd Fig +``` + +3. Build the project: + +```bash +xmake build Fig +``` + +4. Run the program: + +```bash +xmake run Fig [file] +``` + +Replace `[file]` with the path to your input file. + ### 📁 Project Structure . ├── ExampleCodes # Example programs & performance tests diff --git a/README_ZH-CN.md b/README_ZH-CN.md index 73797b2..91f7b88 100644 --- a/README_ZH-CN.md +++ b/README_ZH-CN.md @@ -19,6 +19,34 @@ - **全面的错误处理** - 带有源码位置的详细错误信息 - **干净的 C++ 实现** - 现代 C++23,使用 RAII 和智能指针 +### 使用教程 +1. 克隆存储库: + +```bash +git clone https://github.com/PuqiAR/Fig.git +``` + +2. 切换到项目目录: + +```bash +cd Fig +``` + +3. 构建项目: + +```bash +xmake build Fig +``` + +4. 运行程序: + + + +```bash +xmake run Fig [file] +``` +将`[file]`替换为输入文件的路径。 + ### 📁 项目结构 . ├── ExampleCodes # 示例代码与性能测试样例