From 96fff8e49e7d94181e0b08e9c4a32c6b6a0978d5 Mon Sep 17 00:00:00 2001 From: Old Man Umby Date: Sun, 23 Oct 2022 20:33:39 -0500 Subject: [PATCH] Updated README --- README.md | 43 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0ceb0c6e..b903d7a8 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ View the [Changelog](https://github.com/OldManUmby/DND.SRD.Wiki/blob/master/Chan ### What is D&D 5E SRD REmastered? -This is an adaptation of the D&D 5E SRD available in Markdown (.MD), Microsoft Word (.DOCX), Adobe InCopy/InDesign (.ICML), and many other publishing formats. Please report any issues or discrepancies with the formats or within the material itself; see Discussions & Issues below. +This is an adaptation of the D&D 5E SRD REformatted in Markdown (.MD) for easy export to other publishing formats. Please report any issues or discrepancies within the material itself; see Discussions & Issues below. **The Systems Reference Document (SRD)** contains guidelines for publishing content under the Open-Gaming License (OGL). The [Dungeon Masters Guild](http://dungeonmastersguild.com/) also provides self-publishing opportunities for individuals and groups. The OGL and Dungeon Masters Guild offer different kinds of publishing opportunities. For an overview of the programs, please visit the official [Wizards SRD page](http://dnd.wizards.com/articles/features/systems-reference-document-srd) to compare the programs. -The publishing documents contained herein were REmastered line-by-line into Markdown format and then exported to the other publishing formats to be utilized in your own 5E projects. I have painstakingly converted the original Wizard's SRD v5.1 PDF to markdown, plus all errata from the _Nov 2018 update_. For more information, please visit the [SRD Wiki](https://srd.wiki). +The material contained herein was REmastered line-by-line into Markdown format to be utilized in your own 5E projects. I have painstakingly converted the original Wizard's SRD v5.1 PDF to markdown, plus all errata from the _Nov 2018 update_. For more information, please visit the [SRD Wiki](https://srd.wiki).
Why Markdown format? @@ -22,10 +22,40 @@ Markdown is a lightweight markup language with plain text formatting syntax crea
+
+ Export Options + +I recommend using the following Markdown applications to edit the material: + +* [Typora](https://typora.io): $15 (Pay Once) +* [Visual Studio Code](https://code.visualstudio.com/Download): FREE! + +To export Markdown to various publishing formats, I recommend using [PanWriter](https://panwriter.com). However, for PanWiter to function properly, the following applications must also be installed to maximize your export options: + +* [Download PanDoc](https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-macOS.pkg) + +Alternatively, you can install pandoc using Homebrew: + +`brew install pandoc` + +Homebrew can also install other software that integrates with Pandoc. For example, to install librsvg (its rsvg-convert covers formats without SVG support), Python (to use Pandoc filters), and BasicTeX (to typeset PDFs with LaTeX): + +`brew install librsvg python homebrew/cask/basictex` + +Note: On unsupported versions of macOS (more than three releases old), Homebrew installs from the source, which takes additional time and disk space for the ghc compiler and dependent Haskell libraries. + +There is a zip file containing the binaries and man pages, for those who prefer not to use the installer. Simply unzip the file and move the binaries and man pages to whatever directory you like. + +By default, Pandoc creates PDFs using LaTeX. Because a full MacTeX installation uses four gigabytes of disk space, we recommend BasicTeX or TinyTeX and using the tlmgr tool to install additional packages as needed. If you receive errors warning of fonts not found: + +`tlmgr install collection-fontsrecommended` + +
+
Obsidian Friendly -This adaption of the D&D 5E SRD contains content designed specifically for PKM applications like Obsidian. [Obsidian.md](https://obsidian.md) is a powerful knowledge base on top of a local folder of plain text Markdown files. That definition sounds simple; however, Obsidian is much, much more. Visit Josh Plunket's YouTube Channel to learn more about using Obsidian for your roleplaying game campaign management. +This adaption of the D&D 5E SRD contains optional content designed specifically for PKM applications like Obsidian. [Obsidian.md](https://obsidian.md) is a powerful knowledge base on top of a local folder of plain text Markdown files. That definition sounds simple; however, Obsidian is much, much more. Visit [Josh Plunket's YouTube Channel](https://www.youtube.com/c/JoshPlunkett/videos) to learn more about using Obsidian for your roleplaying game campaign management.
@@ -40,10 +70,9 @@ Feel free to visit our [discussion](https://github.com/OldManUmby/OGL-SRD5/discu Get Downloads * Download the latest [Release](https://github.com/OldManUmby/DND.SRD.Wiki/releases), which includes the complete repository of all files. -* Download the [Markdown](https://github.com/OldManUmby/DND.SRD.Wiki/archive/master.zip) or select another [publishing format](https://github.com/OldManUmby/DND.SRD.Wiki/tree/master/downloads). -* Download the official [SRD v5.1 in PDF format](http://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf) -* Download the official [Errata and FREE Basic Rules](http://dnd.wizards.com/articles/features/basicrules). -* Download the official [Characters Sheets](http://dnd.wizards.com/articles/features/character_sheets). +* Download Wizard's official [SRD v5.1 in PDF format](http://media.wizards.com/2016/downloads/DND/SRD-OGL_V5.1.pdf) +* Download Wizard's official [Errata and FREE Basic Rules](http://dnd.wizards.com/articles/features/basicrules). +* Download Wizard's official [Characters Sheets](http://dnd.wizards.com/articles/features/character_sheets).