https://github.com/teddy-van-jerry/ip-doc

LaTeX Class for IP Core Documentation
https://github.com/teddy-van-jerry/ip-doc

cls hardware ip ip-core latex latex-template latex3

Last synced: 8 days ago
JSON representation

LaTeX Class for IP Core Documentation

• Host: GitHub
• URL: https://github.com/teddy-van-jerry/ip-doc
• Owner: Teddy-van-Jerry
• License: lppl-1.3c
• Created: 2024-09-27T01:22:37.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-10-17T22:27:26.000Z (2 months ago)
• Last Synced: 2024-10-27T15:31:23.512Z (about 2 months ago)
• Topics: cls, hardware, ip, ip-core, latex, latex-template, latex3
• Language: TeX
• Homepage: https://go.wqzhao.org/ip-doc-example
• Size: 803 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `ip-doc` LaTeX Class for IP Core Documentation

Document intellectual property (IP) cores professionally.

## Features

- Beautiful documentation for you to concentrate on writing good contents.

- Easy to use and customize thanks to the LaTeX3 technology.

- Fully open source and free on [GitHub](https://github.com/Teddy-van-Jerry/ip-doc).

[**Example IP Documentation**](https://teddy-van-jerry.github.io/ip-doc/ip-doc-example.pdf)

## Usage

[`ip-doc-example.tex`](ip-doc-example.tex) is an example of how to use this class. You can copy it and modify it to create your own documentation.

Alternatively, [`ip-doc-blank.tex`](ip-doc-blank.tex) is a blank template for you to start with.

## License

This project is open-source under the [LPPL license](LICENSE).

This project is maintained by [Teddy van Jerry](https://github.com/Teddy-van-Jerry) ([Wuqiong Zhao](https://wqzhao.org)).