# riscv-debug-learning

**Repository Path**: korbenyuan/riscv-debug-learning

## Basic Information

- **Project Name**: riscv-debug-learning
- **Description**: riscv debug learning
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-24
- **Last Updated**: 2021-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

README
========

NOTE
----

> 本文档使用debian/Linux（ubuntu/Linux相似）编辑

> 若使用windows, 请直接查看 `build/latex/riscv-debug-learning.pdf`

安装Sphinx
------------

```
pip install sphinx sphinx-autobuild sphinx_rtd_theme
```

支持markdown编写
--------------------

```
pip install recommonmark
```

生成html
-----------

```
make help
make html

firefox build/html/index.html
```

生成pdf
----------

```
sudo apt-get install texlive-full
make latexpdf

firefox build/latex/riscv-debug-learning.pdf
```

查看文件
---------

```
build/
├── html
|   └── index.html
└── latex
    └── riscv-debug-learning.pdf
```


Sphinx 文档
------------------------------------------------------------------------------


[Sphinx 使用手册](https://zh-sphinx-doc.readthedocs.io/en/latest/index.html)

[Docutils 项目](https://docutils-zh-cn.readthedocs.io/zh_CN/latest/index.html)