README_zh.md · MoleSir/XTaro

# XTaro

[一款开源、跨工艺的 SRAM 编译器](https://gitee.com/MoleSir/XTaro.git)

## 项目构建

XTaro 基于 C++20 编写，使用 xmake 作为构建工具。并且调用外部仿真器实现 SPICE 仿真（支持 ngspice 与 spectre）。

### 安装依赖

以 Ubuntu22.04 为例：

- C++20：最简单的是下载 gcc-13

````bash
    sudo apt update
    sudo apt install build-essential
    sudo add-apt-repository ppa:ubuntu-toolchain-r/test
    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-13 100
    sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 100
    ````

- [xmake](https://xmake.io/#/)：官网有下载教程，部分 linux 发行版可以直接使用包管理工具下载

````bash
    sudo apt install xmake

- ngspice/spectre：ngspice 可以直接使用包管理工具下载。spectre 是收费软件

```bash
    sudo apt install ngspice
    ```

- bison：使用包管理工具下载

````bash
    sudo apt install bison

### 编译

下载源码

````bash
git clone https://gitee.com/MoleSir/XTaro.git && cd XTaro
````

接着使用 xmake 编译项目

````bash
xmake build
````

如果在根目录下出现 `xtaor` 表示编译成功，尝试调用：

```bash
./xtaro
```

将在屏幕上显示帮助信息。

> 如果第一次执行 `xmake build` 在链接时期显示有关 LefDefParser 的错误，再执行一次 `xmake build` 可以解决。大概是 Bison 的问题，还没找到更好的解决方案。

## 项目结构

- [compiler](./compiler/)：编译器源码
- [document](./document/)：文档
- [example](./example/)：输入配置文件示例
- [technology](./technology/)：工艺库目录
- [third party](./third_party/): 第三方开源库代码

##  License

[木兰宽松许可证, 第2版](LICENSE)

##  致谢

开发过程中，采用了来自开源社区的代码。具体情况如下：

|   子模块   |                             来源                             |                           详细用途                           |
| :--------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
| lef parser | [Si2 LEF parser](https://github.com/The-OpenROAD-Project-Attic/lef.git) + [LEF/DEF util](https://github.com/jinwookjungs/lefdef_util.git) | 使用 Si2 LEF 库实现 lef 文件的解析，并且参考 LEF/DEF util 学习使用 Si LEF |

感谢来自开源社区的支持。

MoleSir/XTaro

简介

发行版

贡献者

近期动态

MoleSir/XTaro .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

MoleSir/XTaro