From d04b066fc30422a0f99d94e42d2006b061d9b0ee Mon Sep 17 00:00:00 2001 From: ackman678 Date: Wed, 30 May 2018 11:51:41 -0700 Subject: [PATCH] readme update --- README.md | 10 ++++++++-- ...-ganglia-circuits.dot => basal-ganglia-circuits.dot | 0 ...-ganglia-circuits.svg => basal-ganglia-circuits.svg | 0 2017-04-07-ppc-circuits.dot => ppc-circuits.dot | 0 2017-04-07-ppc-circuits.svg => ppc-circuits.svg | 0 5 files changed, 8 insertions(+), 2 deletions(-) rename 2016-11-21-basal-ganglia-circuits.dot => basal-ganglia-circuits.dot (100%) rename 2016-11-21-basal-ganglia-circuits.svg => basal-ganglia-circuits.svg (100%) rename 2017-04-07-ppc-circuits.dot => ppc-circuits.dot (100%) rename 2017-04-07-ppc-circuits.svg => ppc-circuits.svg (100%) diff --git a/README.md b/README.md index 9ce7908..2c1f09d 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ All content in this repo should be contributed with the intention of being openl This repo will be made public after initial setup. -### What is svg? +## What is svg? [Scalable Vector Graphics (svg)](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) is an open W3C standard for 2D vector graphics exchange over the world wide web. It is just a markup (xml) specification. svg files can be created, opened, and edited with any **plain text editor**. svg content can also be created with many open source or proprietary interactive graphics programs and can be viewed with any web browser. In the context of a web application, svg can be styled with css and scripted/animated with JavaScript. -### Notes +## Notes The type of svg graphics added to this git repo should primarily be a mix of simple line drawings, shading, and text. *Usage of raster/image data should be minimized.* Though svg files can contain images-- either as embedded data or as a hypertext link to remote url-- embedded images get encoded as a [base64 data format](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) in svg graphics files. Base64 is a highly portable, but less efficient (e.g wasteful) way of storing real image data compared with raster formats like png/jpeg). Thus if the desired content does not require too many individual objects, it should just be composed as a vector graphic. @@ -18,3 +18,9 @@ Graphics from here can then be openly patched into more complex figure/svg graph All are welcome to contribute. The free and open source [Inkscape](https://inkscape.org) drawing program is highly recommended for creating or editing svg graphics figures. Libreoffice has some nice diagramming tools as well. Graphviz (dot language) is good for diagrams of networks. + +### Network diagrams + +With the open source graph visualization software [GraphViz](http://www.graphviz.org/) locally installed, the plain text `.dot` files can be edited and then rendered with a command like this: + +`dot ppc-circuits.dot -Tsvg -o ppc-circuits.svg` diff --git a/2016-11-21-basal-ganglia-circuits.dot b/basal-ganglia-circuits.dot similarity index 100% rename from 2016-11-21-basal-ganglia-circuits.dot rename to basal-ganglia-circuits.dot diff --git a/2016-11-21-basal-ganglia-circuits.svg b/basal-ganglia-circuits.svg similarity index 100% rename from 2016-11-21-basal-ganglia-circuits.svg rename to basal-ganglia-circuits.svg diff --git a/2017-04-07-ppc-circuits.dot b/ppc-circuits.dot similarity index 100% rename from 2017-04-07-ppc-circuits.dot rename to ppc-circuits.dot diff --git a/2017-04-07-ppc-circuits.svg b/ppc-circuits.svg similarity index 100% rename from 2017-04-07-ppc-circuits.svg rename to ppc-circuits.svg