VeniVidiVici
/
xcomm
mirror of https://github.com/XS-MLVP/xcomm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme: update

This commit is contained in:
yaozhicheng 2025-01-08 12:07:58 +08:00
parent cf590ca945
commit cd6c72fa85
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.cn.md
View File

@ -5,10 +5,10 @@
xspcomm 为 picker 的公用数据定义与操作接口，包括接口读/写、时钟、协程、SWIG回调函数定义等。xspcomm以基础组件的方式被 DUT、MLVP、OVIP等上层应用或者库使用。xspcomm需要用到C++20的特征，建议使用g++ 11 以上版本， cmake 版本大于等于3.11。当通过SWIG导出Python接口时，需要 swig 版本大于等于 4.2.0。
**编译：**
通过make命令进行编译， 通过参数 BUILD_XSPCOMM_SWIG 可开启Python等语言支持 (目前swig接口支持python, javascript, java, scala, golang)，编译完成后生成文件位于 build目录：
通过make命令进行编译， 通过参数 BUILD_XSPCOMM_SWIG 可开启Python等语言支持 (目前swig接口支持python, javascript, java, scala, golang, lua)，编译完成后生成文件位于 build目录：
```bash
make BUILD_XSPCOMM_SWIG=python,scala,java,golang
make BUILD_XSPCOMM_SWIG=python,scala,java,golang,lua
# results
build/python/
@ -22,6 +22,10 @@ build/scala/
└── xspcomm-scala.jar # scala 模块
build/java/
└── xspcomm-java.jar # java 模块
build/lua
├── luaxspcomm.so -> luaxspcomm.so.0.0.1
├── luaxspcomm.so.0.0.1
└── xspcomm.lua
build/golang/
└── src # golang 模块
└── xspcomm

8
README.en.md
View File

@ -6,10 +6,10 @@
xspcomm is the common data definition and operation interface for picker, including interface read/write, clock, coroutine, SWIG callback function definition, etc. xspcomm is used as a basic component by upper-level applications or libraries such as DUT, MLVP, OVIP. xspcomm requires features of C++20, it is recommended to use g++ version 11 or above, and cmake version greater than or equal to 3.11. When exporting Python interface through SWIG, swig version greater than or equal to 4.2.0 is required.
**Compile:**
Compile using the make command. Enable support for Python and other languages by specifying the BUILD_XSPCOMM_SWIG parameter (currently, the SWIG interface supports Python, JavaScript, Java, Scala, and Go). Upon completion of compilation, the generated files will be located in the build directory:
Compile using the make command. Enable support for Python and other languages by specifying the BUILD_XSPCOMM_SWIG parameter (currently, the SWIG interface supports Python, JavaScript, Java, Scala, Go and Lua). Upon completion of compilation, the generated files will be located in the build directory:
```bash
make BUILD_XSPCOMM_SWIG=python,scala,java,golang
make BUILD_XSPCOMM_SWIG=python,scala,java,golang,lua
# results
build/python/
@ -23,6 +23,10 @@ build/scala/
└── xspcomm-scala.jar # scala package
build/java/
└── xspcomm-java.jar # java package
build/lua
├── luaxspcomm.so -> luaxspcomm.so.0.0.1
├── luaxspcomm.so.0.0.1
└── xspcomm.lua
build/golang/
└── src # golang module
└── xspcomm