Skip to content

Evian-Zhang/llvm-ir-tutorial

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

LLVM IR入门指南

本仓库是我写的LLVM IR入门指南。

目前提供PDF版本epub版本下载。(当前版本:v1.0)

目录

在哪可以看到我的文章

我的LLVM IR入门指南系列可以在我的个人博客、GitHub:Evian-Zhang/llvm-ir-tutorial知乎CSDN中查看,本教程中涉及的大部分代码也都在同一GitHub仓库中。

本人水平有限,写此系列文章仅希望与大家分享学习经验,文章中必有缺漏、错误之处,望方家不吝斧正,与大家共同学习,共同进步,谢谢大家!

从源码编译

若想手动将本仓库的markdown文件转化为PDF,epub格式或其他阅读格式:

  1. 下载安装MarkdownPP以及相应的依赖

  2. 在本目录下使用

    markdown-pp index.mdpp -o LLVM-IR-tutorial.md

    后会得到LLVM-IR-tutorial.md的markdown文档

  3. 选择自己喜欢的markdown格式转换工具进行相应的格式转换

目前,我使用的是Typora自带的格式转换工具生成PDF和epub文档。

还有其他可以选择的方案,但均有优劣:

  • gitbook-cli
    很可惜项目已经被废弃,目前在我电脑中已经无法正常运行
  • mdBook
    很有前景的方案,但仍在开发中,尚未成熟,无法导出符合要求的epub文档
  • pandoc
    生成的PDF较为丑陋,而且要支持中文需要额外的配置
  • sphinx-doc
    原生支持的是reStructuredText格式的文本,对markdown格式还是通过插件支持的,在markdown里插入图片会有错误

如果大家了解什么目前能用的,能将markdown转化为比较好看的PDF及epub格式的工具,欢迎提issue或PR。