home.md

@@ -12,6 +12,13 @@ Some components may be regrouped as a single part (due to the conception process
 
 In order to have a model as light as possible eventually, all the components that are not visible, doubled or useless for any reason should be removed.
 
+## Usage
+
+The editor is launched using the java jvm. A Nomad server with the configuration of the instrument must run. The editor can then be launched:
+
+``
+  java -jar target/nomad-3d-editor-0.0.1-SNAPSHOT.jar tcp://localhost:7000:n3d
+``
 
 ## Interface
 
@@ -19,23 +26,37 @@ In order to have a model as light as possible eventually, all the components tha
 
 The editor interface is composed of 3 parts :
 
-1. 3D view of the model of the instrument
-2. Hierarchical view of the components of the model
-3. Menu bar
+1. 3D view of the model of the instrument.
+2. Hierarchical view of the components of the model.
+3. Menu bar.
+
+### Controls
+
+#### General
+
+* Help > Camera : Shows the help for the movements.
+* View > Level of detail : Selects the displayed level of detail.
+* Ctrl + mouse : Changes the speed of the camera.
 
-### Mouse
+#### Mouse
 
 The components can be manually moved around their axis by clicking them with mouse left and dragging the mouse.
 
 The camera is controlled by the mouse :
-* Middle click + drag : rotate around the point of reference
-* Right click + drag : translate in the view plane
-* Scroll up : zoom in
-* Scroll down : zoom out
-* Control down : increase the sensitivity of translation and zoom
-* Shift down : decrease the sensitivity of translation and zoom
-
-### Selection
+* Middle click + drag : Rotate around the point of reference.
+* Right click + drag : Translate in the view plane.
+* Scroll up : Zoom in.
+* Scroll down : Zoom out.
+* Control down : Increase the sensitivity of translation and zoom.
+* Shift down : Decrease the sensitivity of translation and zoom.
+
+#### Selection
+
+* Ctrl + click left : Selects a leaf component. To obtain the parent hierarchy, a - appears in all the parents, then we can click on a parent to select the hierarchy.
+* A : Selects everything or nothing.
+* S : Toggles to a state where the components are selected when the mouse is over.
+* D : Reverses, unselects.
+* W : Once selected, the components become walls.
 
 The components can be selected either in the 3D view by pressing ctrl + left click or by checking their item in the tree view. When a component is selected in the tree view, all its descendants are selected. The 3D view selection only selects leaf components.