From abea005b201aac194faee1f98e7fab4f1be8caba Mon Sep 17 00:00:00 2001 From: Koki Oyatsu Date: Thu, 17 Jan 2019 11:13:28 +0900 Subject: [PATCH 1/2] refs #16 #22: Update README.md * Setup manual * Add Credits --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 7393293..30787e2 100644 --- a/README.md +++ b/README.md @@ -44,8 +44,42 @@ Export to file 1. Press `Ctrl+Shift+p` (windows) or `Command+Shift+p` (Mac) and select `ERD: Save as SVG` or `ERD: Save as PNG` or `ERD: Save as PDF`. +## Setup +### Windows + +1. Download erd-go from https://github.com/kaishuu0123/erd-go/releases. + * Destination directory Example + * C:\Users\<user name>\Tools\windows_amd64_erd-go.exe +2. Download dot program from https://github.com/kaishuu0123/graphviz-dot.js/releases + * Destination directory Example + * C:\Users\<user name>\Tools\graphviz-dot-win-x64.exe + * When you want to use png output + * Install graphviz + * https://www.graphviz.org +3. edit vscode settings.json + ```json + { + "erd-preview.erdPath": "C:\\Users\\<user name>\\Tools\\windows_amd64_erd-go.exe", + "erd-preview.dotPath": "C:\\Users\\<user name>\\Tools\\graphviz-dot-win-x64.exe", + } + ``` + * When uou want to use png output + * Please search dot.exe program path. + * ex.) C:\Program Files(x86)\Graphviz2.30\bin\dot.exe + +### MacOSX + +## Credits + +This work is based off of several existing projects: + +* https://github.com/qjebbs/vscode-plantuml +* https://github.com/vitaliymaz/vscode-svg-previewer + ## Known Issues +* https://github.com/kaishuu0123/vscode-erd/issues + ## Release Notes ----------------------------------------------------------------------------------------------------------- From d1849be79b966cae87e54e03e9598dc8199bc219 Mon Sep 17 00:00:00 2001 From: Koki Oyatsu Date: Thu, 17 Jan 2019 11:16:56 +0900 Subject: [PATCH 2/2] increment version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c6f9d2e..76daa75 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "vscode-erd-preview", "displayName": "ERD Preview", "description": "An extension for Visual Studio Code to preview erd(.er) files", - "version": "4.0.1", + "version": "4.0.2", "publisher": "kaishuu0123", "engines": { "vscode": "^1.25.0"