From 1517aa8d6a39c67f54d541b55ef9b4f2b85b64d1 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 17 Feb 2020 22:15:57 +0000 Subject: circuit-macros (17feb20) git-svn-id: svn://tug.org/texlive/trunk@53821 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/circuit-macros/README | 76 ++++++++++++----------- 1 file changed, 39 insertions(+), 37 deletions(-) (limited to 'Master/texmf-dist/doc/latex/circuit-macros/README') diff --git a/Master/texmf-dist/doc/latex/circuit-macros/README b/Master/texmf-dist/doc/latex/circuit-macros/README index 40768bb81af..3d31e4eb616 100644 --- a/Master/texmf-dist/doc/latex/circuit-macros/README +++ b/Master/texmf-dist/doc/latex/circuit-macros/README @@ -1,10 +1,10 @@ -* Circuit_macros Version 9.1, copyright (c) 2019 J. D. Aplevich under * -* the LaTeX Project Public License. The files of this distribution may * -* be redistributed or modified provided that this copyright notice is * -* included and provided that modifications are clearly marked to * -* distinguish them from this distribution. There is no warranty * -* whatsoever for these files. * +* Circuit_macros Version 9.2, copyright (c) 2020 J. D. Aplevich under * +* the LaTeX Project Public Licence in file Licence.txt. The files of * +* this distribution may be redistributed or modified provided that this * +* copyright notice is included and provided that modifications are clearly * +* marked to distinguish them from this distribution. There is no warranty * +* whatsoever for these files. * This is a set of macros for drawing high-quality line diagrams to include in LaTeX, web, or similar documents, with support for SVG @@ -26,6 +26,9 @@ recursion. Arbitrary text for formatting by LaTeX can be included. Free interpreters for m4 and pic are readily available. +Sources are available as a git repository at + https://gitlab.com/aplevich/Circuit_macros + REQUIRED SOFTWARE: Preferred setup: GNU m4, dpic (see below), LaTeX, PSTricks, dvips @@ -56,7 +59,8 @@ USAGE or pstricks graphics for LaTeX; see below for integration with other tools and production of other formats. You probably should try out the basic usage before integrating the macros with sophisticated - system-dependent tools. + system-dependent tools. When developing your own diagrams, refer to + the macro descriptions in the List of Macros section of Circuit_macros.pdf. Suppose that a source file, cct.m4 say, has been created and the top two lines are @@ -114,7 +118,7 @@ USAGE INSTALLATION: 1. Decide where you will be installing the .m4 library files. In - principle, they can go anywhere, for example, $HOME/Circuit_macros, + principle, they can go anywhere; for example, $HOME/Circuit_macros, c:\localtexmf\Circuit_macros, /usr/local/share/Circuit_macros, or ~/texmf/tex/latex/Circuit_macros. Copy the files from the top-level directory of the distribution to the installation @@ -186,10 +190,14 @@ TESTING: The .m4 files in the examples directory can serve as models for your diagrams but keep in mind that some of them contain details that allow - the source to be used with a variety of postprocessors. Sticking to - one postprocessor such as tikz or PStricks allows for the simplest - source. You might also wish to browse some of the files that are not - used for examples.ps. + the source to be used with a variety of postprocessors. Sticking to one + postprocessor such as tikz or PStricks allows for the simplest source. + You might also wish to browse some of the included files that are not + used to make examples.ps. + + A few of the sources in the examples directory are copies of files + from the doc directory. They are duplicated to provide flexibility + of directory structure and independency of sources. No "make" facility? You have to test by hand (but see below for diagram production software). Copy a test file as above into @@ -246,6 +254,9 @@ DPIC: http://ece.uwaterloo.ca/~aplevich/dpic/ and a git repository containing complete source is at https://gitlab.com/aplevich/dpic + The source can be found in a number of repositories but many contain + older versions, see https://repology.org/project/dpic/badges + The best advice is to obtain the newest version. The dpic distribution includes a manual dpic-doc.pdf containing a summary of the pic language and descriptions of features unique to dpic. @@ -257,7 +268,7 @@ EXAMPLES AND INTEGRATION WITH OTHER TOOLS: Read the manual Circuit_macros.pdf and view or print the file examples.ps in the examples directory. There are a few other source - files in the examples directory that are not shown in examples.ps. + files in the examples directory that are not shown in examples.pdf. For the possibly unstable development version of these macros, try http://ece.uwaterloo.ca/~aplevich/Circuit_macros/ @@ -270,41 +281,35 @@ EXAMPLES AND INTEGRATION WITH OTHER TOOLS: beginning so archived instructions on the net may be slightly more complicated than currently necessary. However, a number of people have developed tools that simplify workflow for their circumstances, - which are beyond the scope of this distribution. The following may - be of interest: - - Fabrice Salvaire provides a brief introduction at - https://www.fabrice-salvaire.fr/en/blog/electronic-circuit-diagrams/ + which are beyond the scope of this distribution. A set of examples and hints intended for his colleagues has been produced by Alan Robert Clark at http://ytdp.ee.wits.ac.za/cct.html - A KDE interface created by Matteo Agostinelli can be found at - http://wwwu.uni-klu.ac.at/magostin/cirkuit.html - A git repository of a newer version of cirkuit by Andrew G. for Linux is at - https://github.com/ag-ckt/cirkuit/tree/V0.5.0 + A Python-based GUI called PyCirkuit is at + https://pypi.org/project/pycirkuit/ and + https://github.com/orestesmas/pycirkuit. + For an introduction, look at the FOSDEM video by Orestes Mas: + https://ftp.osuosl.org/pub/fosdem/2020/H.2215/pycirkuit.webm - The GUI front end PyCirkuit at https://pypi.org/project/pycirkuit/ - and https://github.com/orestesmas/pycirkuit - is Python-based and inspired by cirkuit. + A KDE interface created by Matteo Agostinelli can be found at + http://wwwu.uni-klu.ac.at/magostin/cirkuit.html. A git repository + of a newer version of cirkuit by Andrew G. for Linux is at + https://github.com/ag-ckt/cirkuit/tree/V0.5.0. Because of changes + in library dependencies, there is uncertainty about installation + possibilities. A wiki offering examples and tips is at http://swwiki.e-dschungel.de/circuit_macros It is in German but Google translate works well on the page. + Variations: + See eschpic on Github for IEC-style electrical drawings. + Mac users: A previewer app for Mac OS X written by Collin J. Delker is available at http://www.collindelker.com/wp/2013/04/circuit_macros_previewer/ - For more examples in the context of a textbook, have a look at - Aplevich, J.D., "The Essentials of Linear State-Space Systems," New - York: John Wiley & Sons Inc., 2000. In Canada, look at Andrews, - G.C., Aplevich, J.D., Fraser, and R.A., MacGregor, C.G., - "Introduction to Professional Engineering in Canada," (fifth edition) - Toronto: Pearson Education Canada, Inc., 2018. Some samples from these - books can be found at - http://ece.uwaterloo.ca/~aplevich/ - For an example of the use of dpic in a wiki (thanks to Jason Grout), see http://jasongrout.org/software/dokuwiki/format-plugin @@ -329,9 +334,6 @@ EXAMPLES AND INTEGRATION WITH OTHER TOOLS: Stevens illustrated his books on Unix and TCP/IP using pic macros. Some of the sources found there need minor tuning to work under dpic. -TikZ-PGF: Check the Makefile in the examples/pgf directory as described - in the README file, and type "make" or "make examples.pdf". - MetaPost examples: Go to the examples/mpost directory. Check the Makefile as described in the README file, type "make", and stand well back. -- cgit v1.2.3