System block designer/controller. Code
Status: Alpha
Brought to you by:
p_christeas
Menu
▾
▴
Tree [29fbc7] master / History
Panagiotis Christeas
p_christeas
Read Me
General Instructions for kshower ---------------------------------- This is a draft document, following the code maturity of the project. At the time of this document, kshower is pre-0.3 . As kshower is on a 0.x release, please bear with any bugs/defects it may have at the moment. I consider it an alpha status, which I offer to the community mainly to demonstrate the principle and ask their opinion on that. Most functions/features are at the moment partially implemented, just in order to have the skeleton of the application up and running. I (and any joining developers of this project) will welcome your feedback. (short) Usage instructions ---------------------- 1. Compile and install the application somewhere (usual GNU-stuff, nothing special here). Please feel free to abuse me if something goes wrong here.. TODO: test the default toolbars/icons installation 2. Note that you can't do anything with kshower unless you "initialize the space". So, go for the 'Init space' action, or all others will crash the app. kshower 0.3 comes with 3 memspace implementations: - Design Space: here you create/manipulate the 'shapes' - Simple space: here you build diagrams based on those 'shapes'. Don't use this as it has no save/load. - Url Space: this is a simple space, which can load and save at xml format. It can also have one URL associated with each plh (=shape). Note about actions ------------------ The layout of toolbars may be other/wrong at your installation. Therefore I refer to the action's name whenever I want you to use one. You can always adjust them through the 'Toolbar preferences' menu item. 3a. Design space works out of the box. You create a shape, enter a name at the 'Select shape' action and assign it a name. Then, start the next shape, eventually deleting any remaining items on the canvas. If you do so, save the shapes file at the end.. Note: please observe the stderr of kshower. It may give you a hint why the app crashed or not behaved the way you wanted it.. 3b. Simple space and Url Space need the 'Import DesMSpace' action before they can do anything. Use your shapes or the ones that are given in the doc/samples/'Test shapes 3.kshower'. Then, use the 'Select type' combo box (on the toolbar) to insert shapes into the diagram. There is also a 'Select' tool and an 'Edit' action, which let you move and manipulate these shapes. 4. I hope the provided samples give you a clue about the capabilities of the program. I also apologize for not explaining in details how the shapes and tools work at the moment. Following your feedback, we may change this behaviour and have kshower 0.4+ work differently.. Thank you for any interest in this project! P. Christeas <p_christeas@yahoo.com>
