PowerShell is already included with Windows, so skip this chapter if using Windows. PowerShell is required to execute the document compiler that transforms source text into final output HTML and PDF. If using Linux, contact your Linux distribution vendor for instructions on installing wkhtmltopdf. On Windows, this component is embedded in the document compiler - skip this chapter. Wkhtmltopdf is a prerequisite for the DASH-IF document compiler. If using Linux, contact your Linux distribution vendor for instructions on installing Graphviz. If using Linux, contact your Linux distribution vendor for instructions on installing Java. Open a new terminal window and verify that the java -version command succeeds.Leave all the options in the installer at their default values.If you get a SmartScreen warning popup, click “More Info” and “Run anyway” to bypass it.Execute this MSI file and follow the displayed instructions to finish installing Java.MSI file (the filename should be similar to java-11-openjdk-11.0.1.86_64.msi). On Windows, the preferred version of Java is OpenJDK 11. If this command succeeds and shows a version string, you already have Java. You can test by executing java -version in a terminal window. If you already have Java installed, skip this chapter. Java is a prerequisite of various parts of the workflow. You may need to slightly deviate from these instructions if your working environment is unusual. The following chapters guide you through setting up all of this. wkhtmltopdf - a prerequisite for the document compiler.Graphviz - a prerequisite for PlantUML.Java - a prerequisite for several of the above apps.Git - for synchronizing local files with GitHub repositories.DASH-IF PowerShell module for document authoring - generates the final output documents.yEd - a boxes-and-arrows diagram editor.PlantUML plugin for Visual Studio Code - a sequence/component diagram generator.Visual Studio Code - this is the preferred text editor for document authoring.The following software will be installed: You must have administrator-level access to the system (or ask someone with such an access level to perform the setup). Please report any success or failure in Slack if you try macOS! MacOS compatibility is unknown but theoretically likely. Recent version of your preferred Linux distribution with a desktop environment.You need one of the following operating systems: Simple editing operations may also be possible online on GitHub, without any local installation.Īdvanced users are free to deviate from these instructions if they have familiar alternatives that can fulfill the same goals. Join DASH-IF on Slack! Local environment setupįollow the instructions on this page to set up a complete local installation of the document authoring tools. DocumentAuthoring GitHub+Bikeshed based document authoring guide and associated tooling. DocumentAuthoring | GitHub+Bikeshed based document authoring guide and associated tooling.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |