diff options
Diffstat (limited to 'doc/en/quick.docbook')
| -rw-r--r-- | doc/en/quick.docbook | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/en/quick.docbook b/doc/en/quick.docbook new file mode 100644 index 0000000..3785ba7 --- /dev/null +++ b/doc/en/quick.docbook @@ -0,0 +1,42 @@ +<!-- kate: tab-width 2; indent-mode xml; --> +<chapter id="quick"> + <title>Quick Tour</title> + + <sect1 id="introduction"> + <title>Introduction</title> + + <para>&kappname; is an IDE for electronic circuits and microcontrollers. It can perform simulation a variety of components (logic, integrated, linear, nonlinear and reactive), simulation and debugging of PIC microcontrollers via gpsim, and comes with its own closely-linked and complementary high level languages: &flowcode; and µbe;.</para> + + <para>It has been designed to be as easy to use and unintrusive as possible; all components and FlowParts have context sensitive help, and simulating electronics is as simple as dragging components onto the work area and creating connectors that autoroute themselves between their pins. &flowcode; allows users new to PICs to instantly create their own programs, while the electronic simulation allows stepping through a PIC's assembly program inside a circuit.</para> + </sect1> + + <sect1 id="documents"> + <title>Documents</title> + <para>To get started in &kappname;, you will need to create a new document, whose type will depend on your task: + + <itemizedlist> + <listitem><para>&flowcode; Document - Construct a PIC program via flowcharting.</para></listitem> + <listitem><para>Circuit Document - Simulate electronics circuits and microcontrollers.</para></listitem> + <listitem><para>µbe; Document - High level language for PICs, also used by &flowcode; to generate assembly.</para></listitem> + <listitem><para>Assembly Document - Start writing a PIC assembly program.</para></listitem> + </itemizedlist> + + &kappname; uses a Document-View model, in that the Document logic is completely seperate from open views of the document. This allows several views of the same file.</para> + + <para>On creating a new document, the view is created in a seperate tab. Each tab can support any number of views, tiled in any arbitary pattern. This allows, for example, simulating a PIC program in circuit, while stepping through the program in an assembly document in the same tab.</para> + + <para>The contents of tabs can be duplicated by dragging the tab to an empty area on the tab bar. They can be inserted into an existing tab by dragging it onto that tab.</para> + + <para>Detailed instructions on the above documents can be found in their own respective chapters.</para> + </sect1> + + <sect1 id="drawing"> + <title>Drawing</title> + + <para>In Circuit and &flowcode; documents, there are several drawing tools available, including text. These are available by clicking on the paintbrush icon in the toolbar. To draw, drag the mouse to form either a shape or a line appropriate to the drawing tool in use.</para> + + <para>When a drawing is selected, it can be resized by dragging its handles. Holding down shift while dragging will snap the handle to the underlying grid. Each tool has basic options accessible from the toolbar, such as colours. There are also more advanced options found in the Item sidebar, such as line and cap styles.</para> + + </sect1> + +</chapter>
\ No newline at end of file |