https://remedy-entertainment.github.io/USDBook/

Book of USD source repository.
https://remedy-entertainment.github.io/USDBook/

Last synced: about 1 month ago
JSON representation

Book of USD source repository.

• Host: GitHub
• URL: https://remedy-entertainment.github.io/USDBook/
• Owner: Remedy-Entertainment
• License: mit
• Created: 2022-12-09T10:39:57.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-10T16:45:08.000Z (12 months ago)
• Last Synced: 2024-08-05T16:17:03.515Z (5 months ago)
• Language: CSS
• Homepage: https://remedy-entertainment.github.io/USDBook/
• Size: 12.9 MB
• Stars: 156
• Watchers: 9
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-openusd - Book of USD

README

        
# Book of USD

![Preview with Frappe styling of the book](./preview.png)

This book aims to offer a more human-readable and artist friendly way of learning Universal Scene Description (USD) and its jargon. It is not a replacement of the [official USD Glossary](https://graphics.pixar.com/usd/release/glossary.html), but more of a starting point for anyone new to the technology.

## Install Rust language and dependencies

- Follow the instructions on https://www.rust-lang.org/learn/get-started to install rust for your system

- Run `rustup update` to update rust to the latest version

- Run `cargo install mdbook mdbook-catppuccin mdbook-admonish` to install [`mdbook`](https://rust-lang.github.io/mdBook/), [`mdbook-catppuccin`](https://github.com/catppuccin/mdbook) and [`mdbook-admonish`](https://github.com/tommilligan/mdbook-admonish)

## Building

Building is as simple as 

`mdbook build -d `

Be sure to also run `mdbook clean -d ` once in a while

## Previewing

You can also preview the book via `mdbook serve --open` to automatically compile and preview the book in your web browser