Skip to content

TianoCore Documents Required Tools

Jump to bottom
Michael Kinney edited this page Jul 7, 2017 · 11 revisions

Required Tools

Optional Tools

Installing Tools for Windows systems

Installing Optional Tools for Windows systems

Installing Tools for UNIX-Like systems

  1. Configure proxies

  2. Install GIT

    sudo dnf -y install git

  3. Install latest version of calibre-ebook

    • Download from https://calibre-ebook.com/download_linux
    • Run following command with /path/to/downloaded/calibre-tarball.txz replaced with path to downloaded file. 
      sudo mkdir -p /opt/calibre && sudo rm -rf /opt/calibre/* && sudo tar xvf /path/to/downloaded/calibre-tarball.txz -C 
/opt/calibre && sudo /opt/calibre/calibre_postinstall

  4. Install and Initialize NPM

    sudo dnf -y install npm
cd ~
npm init -y

  5. Install gitbook-cli

    npm install gitbook-cli

Installing Optional Tools for UNIX-Like systems

  1. Install Pandoc

    sudo dnf -y install pandoc

  2. Install gitbook-convert

    npm install gitbook-convert

  3. Install GitBook Editor from https://www.gitbook.com/editor/linux

Verify Tool Installation

  1. Run the following commands to clone the EDK II Template Specification to a local directory and build this specification to MOBI, EPUB, PDF, and HTML formats.

    cd ~
mkdir tianocore-docs
cd tianocore-docs
git clone https://github.com/tianocore-docs/edk2-TemplateSpecification.git
cd edk2-TemplateSpecification
gitbook install
gitbook mobi
gitbook epub
gitbook pdf
gitbook serve

  2. Use a web browser to view HTML version at http://localhost:4000

  3. Use a web browser open the following files in the path ~/tianocore-docs/edk2-TemplateSpecification

    • book.mobi
    • book.epub
    • book.pdf

Back to TianoCore Documents Overview

Clone this wiki locally