Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
JanBliznicenko committed Oct 31, 2024
1 parent 01d6b30 commit 38483c8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
5 changes: 3 additions & 2 deletions .github/scripts/build-linux.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,15 @@ cat << EOF > $package_dir/README.txt
To run OpenPonk on Debian-based, Ubuntu-based and possibly other Linux distros, simply use $PROJECT_NAME executable.
## In case of errors/exceptions
OpenPonk might encounter some error when used with some Linux distros. In that case, installation of Pharo programming language is required (sudo privileges needed).
1. Open Pharo builds website: https://software.opensuse.org//download.html?project=devel:languages:pharo:stable&package=pharo-ui
2. Select your Linux distribution.
3. Select "Add repository and install manually".
4. Follow shown instruction if any and execute shown bash code in terminal - one line at a time.
4. Follow shown instructions and execute each bash command in terminal - one line at a time.
You might need to prepend "sudo" before each line.
If your distro version number does not match given options, try manually changing the version number/name in shown code.
If your distro version does not match the given options, try manually updating the version number/name in the code.
After Pharo is installed, you may run OpenPonk using $PROJECT_NAME-pharo-ui executable.
Expand Down
21 changes: 10 additions & 11 deletions .github/scripts/readmecommon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
OpenPonk application is implemented in Pharo programming environment that can be described as a programming OS running in a VirtualBox-like virtual machine.
In the OpenPonk application, you may open multiple OpenPonk windows, each representing an OpenPonk project.
In each OpenPonk project, you may have multiple independent models.
Models alone contain elements, their properties and relations and do not have any information about visual representation.
Diagrams are those visual representations. One model can have many diagram representations and these diagrams may only show small part of a model.
Models contain elements, their properties and relations without any visual representation.
The visual representation is provided by a diagram. One model can be shown using many diagrams and these diagrams may only show small part of the model.

When you add new elements, delete them or change their properties, you change not only the current diagram, but also the model used for all the diagrams of the same model.
If you wish to omit (hide) some elements from a diagram, but keep them in the model (and possibly other diagrams), use Hide menu items. To show them again, use Show.

# Saving

There are two independent saving systems. Option 1 is more convenient on a single computer, but not very safe, while option 2 is generally safer and its save file is more portable. You may actually use both options at once.
There are two independent saving systems: saving entire OpenPonk environment and saving a single project into a project file. It is recommended to save using both ways after doing lots of work that you really do not want to lose, as any of these systems can glitch out, especially the first option.

1) Saving OpenPonk environment:
You may save whole OpenPonk application environment, including open windows, dialog popups, not-yet-properly-saved projects etc. This is very convenient as you save multiple projects at once and everything opens exactly like you saved it. However, if the OpenPonk application glitches and refuses to open, you lose everything that is only saved this way.
It is saved into .image and .changes files inside image directory and these files can become very large and unsuitable for moving to other computers, versioning etc.
It is saved into .image and .changes files inside image directory. These files can become very large and unsuitable for moving to other computers, as the .image file is a full memory serialization.

How to save this way (2 alternatives):
- In very top toolbar > Pharo > Save (or Save and Quit)
Expand All @@ -26,7 +26,7 @@ There are two independent saving systems. Option 1 is more convenient on a singl
- Just open OpenPonk application again

2) Saving a single project:
You may save a single project to an .opp (OpenPonk Project) file, which is a zip file with various json/xml/ other text files with project metadata, models, diagrams etc.
You may save a single project to an .opp (OpenPonk Project) file, which is a zip file with various text files (like xml, json or similar) with project metadata, models, diagrams etc.

How to save this way:
- In OpenPonk project's sub-window > Project > Save Project
Expand All @@ -38,12 +38,11 @@ There are two independent saving systems. Option 1 is more convenient on a singl

# Settings

OpenPonk settings are available after opening Project window, then
OpenPonk > Settings
OpenPonk settings are available from an open project's internal window, using this window's menu: OpenPonk > Settings

# Dragging/Moving elements

Whenever you are dragging elements of a diagram, they attempt to snap to center or sides of other nearby elements.
Whenever you are dragging elements of a diagram, elements automatically snap to the centre or borders of nearby elements when dragged.
To disable snapping for the current drag, hold Alt key when dragging.
To permanently disable it, go to OpenPonk settings and set "Shapes checked for drag snapping" to 0

Expand All @@ -54,7 +53,7 @@ Activating keyboard shortcuts sometimes needs clicking into canvas area once aga

Scroll diagram: arrows
Zoom in/out: +/-
Delete element: Delete (with confirmation dialog) or Ctrl+Delete (without confirmation)
Hide element: Ctrl+H
Save OpenPonk environment (option 1 save): Ctrl+Shift+S
Delete element: Delete (with confirmation dialog) or Shift + Delete (without confirmation)
Hide element: Ctrl + H
Save OpenPonk environment (first saving option): Ctrl + Shift + S

0 comments on commit 38483c8

Please sign in to comment.