If writing LaTeX scares oneself,
Lyx is a nice editor for LaTeX for a gentler learning curve. It is not
exactly what-you-see-is-what-you-get, but close to it; like Word with paragraph marks etc. enabled and not the preview mode. It is designed to help those writing peer-reviewed articles, so there may be some quirks that can feel odd otherwise.
Essentially, LaTeX is a markup language like HTML, Markdown, BBCode (what you use when you post here), and so on. The source code is plain text, just like those others, and is therefore very well suited to be included in your project sources. (It is ridiculously stable, and because of its use in scientific writing, you can expect it to be re-renderable in future decades just as well as it is now.)
Just like browsers render HTML, LaTeX editors and typesetters render LaTeX. See the example
at Wikipedia; the format is really logical. The rendered output is usually also saved as PDF, and therefore viewable in any PDF viewer (including browsers, since web browsers nowadays tend to include a built-in PDF renderer). But note that the PDF is the result, and conversion back to original LaTeX is hard/impossible; you'll definitely want to keep the original plain-text LaTeX sources.
You can render the LaTeX also into HTML, with the non-text parts rendered as SVG (a vector-based, fully scalable format also supported by all browsers). If you look at
my home page, my mascot, Tux, is an SVG image; so, it's a quite good vector format, really good for this. Depending on the settings, it will look very much like the PDF output does.
TikZ-timing is a package in LaTeX (
\usepackage{tikz-timing}), that provides
macros – language functions – to produce the timing graphics. (There are also other macro packages for drawing circuits, for example.) It is based on
PGF/TikZ pair of languages for vector graphics using human-readable plain text algebraic/geometric descriptions. There is also
tikz-circuits.logic for logic circuits and
tikz-circuits.ee for circuit diagrams. There are even tools that can convert your Matlab/Octave diagrams into TikZ, so you can embed them in the plain-text LaTeX document (without relying on embedding the diagram as an external file into the rendered document).
All this means that if you do want to document your electronics and/or embedded projects, LaTeX is actually a very good choice. There are some nice tools you can pick from, on any OS you might wish to use, and they are all compatible with each other. Because its source is plain text, it co-operates
excellently with source code and version management utilities like
git: they can pinpoint the exact changes between different versions.
(If this sounds like a sales pitch, it's just because I myself just realized the above. I haven't written any LaTeX in a couple of years, and had completely forgotten all about its non-physics/math uses, and only now realized how useful it is
for myself for documenting my embedded and circuit ideas. In my own case, I like to use a plain text editor with syntax highlighting, and a separate renderer; it is only a matter of running a single command to have a renderer watch a LaTeX file and whenever I save it, it'll re-render and redisplay the updated file in a fraction of a second. Others like to use an editor like LyX or Overleaf –– there are even add-ons for various browsers (including Microsoft Edge) to use the browser itself as a LaTeX editor, or to render LaTeX used in Github, Discord, etc. Right now I'm simulating a couple of interesting LED driver circuits using ngspice, and using LaTeX to document those, including any math stuff I might wish to remember (like effective pulse width as a function of PWM pulse width), seems like the easiest option.)
Home
Help
Search
Login
Register
