Merge pull request #57 from AkarinServer/master

Add support for MacOS

Author: YuzukiTsuru

README.md

@@ -1,6 +1,8 @@
 # OpenixCard
 
-Open Source Version of Allwinner PhoenixCard to Dump, Unpack, Flash Allwinner Linux IMG Files on Linux
+English ｜ [简体中文](README_ZH.md)
+
+Open Source Version of Allwinner PhoenixCard to Dump, Unpack, Flash Allwinner Linux IMG Files on Linux and MacOS
 
 [![forthebadge](https://forthebadge.com/images/badges/made-with-c-plus-plus.svg)](https://forthebadge.com)
 [![forthebadge](https://forthebadge.com/images/badges/made-with-c.svg)](https://forthebadge.com)
@@ -90,7 +92,7 @@ sudo make install
 ## LICENSE
 ```
 GNU GENERAL PUBLIC LICENSE Version 2, June 1991
-                       
+                        
 Copyright (c) 2022, YuzukiTsuru <GloomyGhost@GloomyGhost.com>
 
 This program is free software; you can redistribute it and/or modify

README_ZH.md

@@ -0,0 +1,297 @@
+# OpenixCard
+
+[English](README.md) ｜ 简体中文
+
+Allwinner PhoenixCard 的开源版本，用于在 Linux 和 MacOS 上解包、转储、烧录 Allwinner Linux IMG 文件
+
+[![forthebadge](https://forthebadge.com/images/badges/made-with-c-plus-plus.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/made-with-c.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
+
+[![CMake](https://github.com/YuzukiTsuru/OpenixCard/actions/workflows/cmake.yml/badge.svg)](https://github.com/YuzukiTsuru/OpenixCard/actions/workflows/cmake.yml)
+
+## 关于 Android IMG 文件支持
+> Android 固件将不被支持，未来也不会适配支持。由于 Android GKI、GMS、GRF 版本众多，无法覆盖所有固件版本，且 Android 固件分区非常复杂，没有通用的方法生成可用的固件，也没有固定的地址使其运行。即使能够适配，也会出现功能不可用的情况，如 fastboot、GMS 服务等。最后，Android 固件修改常用于破解和修改固件，本项目不支持此类行为。
+
+## 程序位置
+
+编译后的可执行文件位于：`build/dist/OpenixCard`
+
+## 基本使用方法
+
+### 1. 查看帮助信息
+```bash
+./build/dist/OpenixCard --help
+# 或
+./build/dist/OpenixCard -h
+```
+
+### 2. 查看版本信息
+```bash
+./build/dist/OpenixCard --version
+# 或
+./build/dist/OpenixCard -v
+```
+
+## 主要功能
+
+### 功能 1: 解包 Allwinner 镜像文件 (-u)
+
+**用途**：将 Allwinner 格式的固件镜像文件解包，提取其中的分区和文件。
+
+**使用方法**：
+```bash
+./build/dist/OpenixCard -u <镜像文件路径>
+```
+
+**示例**：
+```bash
+# 解包名为 firmware.img 的镜像文件
+./build/dist/OpenixCard -u firmware.img
+
+# 解包后会生成一个同名的目录，包含所有解包的文件
+```
+
+**输出**：
+- 创建一个目录（通常与镜像文件名相同）
+- 目录中包含所有分区和文件内容
+
+---
+
+### 功能 2: 解包并生成分区表配置 (-uc)
+
+**用途**：解包镜像文件，同时生成分区表配置文件（.cfg），用于后续重新打包。
+
+**使用方法**：
+```bash
+./build/dist/OpenixCard -uc <镜像文件路径>
+```
+
+**示例**：
+```bash
+./build/dist/OpenixCard -uc firmware.img
+```
+
+**输出**：
+- 解包后的文件目录
+- 分区表配置文件（.cfg），记录了分区的布局信息
+
+**使用场景**：
+- 需要修改固件后重新打包
+- 需要了解镜像的分区结构
+- 备份分区表配置
+
+---
+
+### 功能 3: 转储镜像 (-d)
+
+**用途**：将 Allwinner 专有格式的镜像转换为标准的镜像格式。
+
+**使用方法**：
+```bash
+./build/dist/OpenixCard -d <镜像文件路径>
+```
+
+**示例**：
+```bash
+./build/dist/OpenixCard -d firmware.img
+```
+
+**输出**：
+- 转换后的标准格式镜像文件
+- 通常可以直接用于刷机或挂载
+
+**使用场景**：
+- 将 Allwinner 格式转换为通用格式
+- 提取原始镜像数据
+- 用于其他工具处理
+
+---
+
+### 功能 4: 获取镜像大小 (-s)
+
+**用途**：获取 Allwinner 镜像文件的准确大小信息。
+
+**使用方法**：
+```bash
+./build/dist/OpenixCard -s <镜像文件路径>
+```
+
+**示例**：
+```bash
+./build/dist/OpenixCard -s firmware.img
+```
+
+**输出**：
+- 显示镜像的准确大小（字节数或带单位的大小）
+
+**使用场景**：
+- 验证镜像文件完整性
+- 了解镜像大小以便准备存储设备
+- 调试镜像文件问题
+
+---
+
+### 功能 5: 打包镜像 (-p)
+
+**用途**：从解包后的目录重新打包成 Allwinner 镜像文件。
+
+**使用方法**：
+```bash
+./build/dist/OpenixCard -p <目录路径>
+```
+
+**示例**：
+```bash
+# 假设已经解包了 firmware.img，生成了 firmware 目录
+./build/dist/OpenixCard -p firmware
+```
+
+**前置条件**：
+- 目录中必须包含 `.cfg` 配置文件
+- 目录结构必须完整（通常由 `-uc` 命令生成）
+
+**输出**：
+- 重新打包的镜像文件
+
+**使用场景**：
+- 修改固件后重新打包
+- 创建自定义固件镜像
+- 测试镜像打包功能
+
+---
+
+## 完整工作流程示例
+
+### 场景 1: 分析和修改固件
+
+```bash
+# 1. 解包镜像并生成配置文件
+./build/dist/OpenixCard -uc firmware.img
+
+# 2. 这会生成 firmware 目录和配置文件
+# 3. 修改 firmware 目录中的文件
+# 4. 重新打包
+./build/dist/OpenixCard -p firmware
+
+# 5. 生成新的镜像文件
+```
+
+### 场景 2: 转换镜像格式
+
+```bash
+# 1. 转储为标准格式
+./build/dist/OpenixCard -d firmware.img
+
+# 2. 可以使用其他工具处理转换后的镜像
+```
+
+### 场景 3: 检查镜像信息
+
+```bash
+# 1. 查看镜像大小
+./build/dist/OpenixCard -s firmware.img
+
+# 2. 解包查看内容
+./build/dist/OpenixCard -u firmware.img
+```
+
+## 注意事项
+
+1. **文件路径**：确保镜像文件路径正确，可以使用相对路径或绝对路径
+2. **权限**：确保对目标目录有写入权限
+3. **磁盘空间**：解包操作需要足够的磁盘空间
+4. **配置文件**：打包时需要 `.cfg` 文件，建议使用 `-uc` 选项生成
+5. **备份**：在修改固件前，建议先备份原始镜像文件
+
+## 常见问题
+
+**Q: 如何知道镜像文件是否有效？**
+A: 使用 `-s` 选项检查镜像大小，或尝试 `-u` 解包看是否成功。
+
+**Q: 打包时提示缺少配置文件？**
+A: 使用 `-uc` 选项解包，会自动生成 `.cfg` 配置文件。
+
+**Q: 可以处理哪些类型的镜像？**
+A: 主要用于 Allwinner 芯片的 Linux 固件镜像，不支持 Android 固件。
+
+## 快速参考
+
+```bash
+# 查看帮助
+./build/dist/OpenixCard -h
+
+# 查看版本
+./build/dist/OpenixCard -v
+
+# 解包镜像
+./build/dist/OpenixCard -u <img>
+
+# 解包并生成配置
+./build/dist/OpenixCard -uc <img>
+
+# 转储镜像
+./build/dist/OpenixCard -d <img>
+
+# 获取大小
+./build/dist/OpenixCard -s <img>
+
+# 打包镜像
+./build/dist/OpenixCard -p <dir>
+```
+
+## 下载
+### ArchLinux
+OpenixCard 现在可在 [AUR](https://aur.archlinux.org/packages/openixcard) 上获取 [#3](https://github.com/YuzukiTsuru/OpenixCard/issues/3#issuecomment-1135317155)
+```
+yay -S openixcard
+```
+
+### 其他 Linux
+您可以在以下链接找到最新的发布文件：  
+https://github.com/YuzukiTsuru/OpenixCard/releases
+
+## 从源码构建
+
+```bash
+# 下载源代码
+git clone --recursive --depth 1 https://github.com/YuzukiTsuru/OpenixCard
+
+# 安装依赖
+sudo apt install cmake build-essential automake autoconf libconfuse-dev pkg-config
+
+# 创建构建目录
+mkdir build
+cd build
+
+# 编译
+cmake .. && make -j
+```
+
+> 注意：Ubuntu 20.04 编译会报错，这是由 ar 的 bug 导致的，您可以编译安装新版本。
+
+```bash
+sudo apt-get install texinfo
+
+wget https://ftp.gnu.org/gnu/binutils/binutils-2.38.tar.xz && \
+  tar xvf binutils-2.38.tar.xz && \
+  cd binutils-2.38 && \
+  ./configure --prefix=/usr/local && \
+  make
+  
+sudo make install
+```
+
+## LICENSE
+```
+GNU GENERAL PUBLIC LICENSE Version 2, June 1991
+                        
+Copyright (c) 2022, YuzukiTsuru <GloomyGhost@GloomyGhost.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2 as
+published by the Free Software Foundation.
+
+See README and LICENSE for more details.
+ ```

lib/inicpp

@@ -2,6 +2,11 @@ add_subdirectory(GenIMG)
 add_subdirectory(OpenixIMG)
 add_subdirectory(OpenixCard)
 
+# Find libconfuse for linking
+find_package(PkgConfig REQUIRED)
+pkg_check_modules(CONFUSE REQUIRED libconfuse)
+
 # Main app
 add_executable(OpenixCard main.cpp)
-target_link_libraries(OpenixCard PRIVATE libOpenixCard OpenixIMG inicpp GenIMG)
+target_link_libraries(OpenixCard PRIVATE libOpenixCard OpenixIMG inicpp GenIMG ${CONFUSE_LIBRARIES})
+target_link_directories(OpenixCard PRIVATE ${CONFUSE_LIBRARY_DIRS})

src/CMakeLists.txt

@@ -6,15 +6,22 @@ set(LIBGENIMAGE_SOURCE_DIR "${CMAKE_SOURCE_DIR}/src/GenIMG/genimage-src")
 set(LIBGENIMAGE_TARGET_BUILD_DIR "${CMAKE_BINARY_DIR}/thirdparty/genimage-src/")
 set(LIBGENIMAGE_TARGET_LIBRARY "${CMAKE_BINARY_DIR}/thirdparty/genimage-src/libgenimage.a")
 
+# Find libconfuse
+find_package(PkgConfig REQUIRED)
+pkg_check_modules(CONFUSE REQUIRED libconfuse)
+
 add_library(GenIMG ${GenIMGSource} GenIMG.cpp GenIMG.h GenimageWrapper.h)
-target_link_libraries(GenIMG PRIVATE ${LIBGENIMAGE_TARGET_LIBRARY} Threads::Threads confuse)
+target_include_directories(GenIMG PRIVATE ${CONFUSE_INCLUDE_DIRS})
+target_link_libraries(GenIMG PRIVATE ${LIBGENIMAGE_TARGET_LIBRARY} Threads::Threads ${CONFUSE_LIBRARIES})
+target_compile_options(GenIMG PRIVATE ${CONFUSE_CFLAGS_OTHER})
 
 file(MAKE_DIRECTORY ${LIBGENIMAGE_TARGET_BUILD_DIR})
 
+# Copy genimage-src files to build directory using CMake for cross-platform compatibility
 add_custom_command(
         TARGET GenIMG
         PRE_LINK
-        COMMAND cp -rf "${LIBGENIMAGE_SOURCE_DIR}/*" "${LIBGENIMAGE_TARGET_BUILD_DIR}"
+        COMMAND ${CMAKE_COMMAND} -E copy_directory "${LIBGENIMAGE_SOURCE_DIR}" "${LIBGENIMAGE_TARGET_BUILD_DIR}"
 )
 
 # autotools build

src/GenIMG/CMakeLists.txt

@@ -41,8 +41,8 @@ libgenimage_a_CFLAGS = \
 	$(AM_CFLAGS) \
 	$(CONFUSE_CFLAGS)
 
-libgenimage_a_LIBADD = \
-	$(CONFUSE_LIBS)
+# Note: LIBADD is not used for static libraries in autotools
+# libconfuse will be linked when the final executable is built
 
 noinst_HEADERS = \
 	genimage.h \