From 14e2352e40b517fdf7e3966edbfc2927ff0f0fdd Mon Sep 17 00:00:00 2001 From: Pierre Laborde <49183340+labordep@users.noreply.github.com> Date: Sat, 26 Aug 2023 17:21:13 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 46 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b62dff87..cb302dbe 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,7 @@ Pyramid is a WYSIWYG application (What You See Is What You Get) in other terms i Pyramid helps you to produce final UI using Bloc library (and also Toplo). -## How to start - -Open the Pyramid menu into Library and click `New Project`. - -![image](https://github.com/OpenSmock/Pyramid/assets/49183340/09b28b8e-f2df-489b-8855-68141efa6bf3) - -## Installation +## How to get Pyramid You can load the last stable version of Pyramid or the development version. The Development version can provide the new incoming functionalities but can be unstable. @@ -41,6 +35,44 @@ Metacello new load ``` +## How to use Pyramid + +### Create a new project + +Open the Pyramid menu into Library and click `New Project`. + +![image](https://github.com/OpenSmock/Pyramid/assets/49183340/09b28b8e-f2df-489b-8855-68141efa6bf3) + +Then the project view appears in a new window. + +![image](https://github.com/OpenSmock/Pyramid/assets/49183340/b4f988ff-62e1-452f-b409-75439c584878) + +### Add and setup graphical elements + +Use the create button to add graphical element in your project view. + +https://github.com/OpenSmock/Pyramid/assets/49183340/a02db9ad-314a-4caf-884c-9da4da809293 + +### Save a project + +Setup the project to store your view into a Class. + +When your project is saved into a method, you can see the preview on the `Pyramid preview` tab. + +https://github.com/OpenSmock/Pyramid/assets/49183340/eb70004b-cfb4-43a0-8759-27d3bac75fd0 + +### Edit a saved project + +Use the `Pyramid preview` tab to edit an existing project. + +https://github.com/OpenSmock/Pyramid/assets/49183340/c4a18e51-5fb5-412c-90d4-0638cadb6bff + +### Test a project + +Use the `Pyramid preview` tab to test an existing project. + +https://github.com/OpenSmock/Pyramid/assets/49183340/12a916e5-06d1-426f-954c-2e4e911475e1 + ## Dependencies ![image](https://github.com/OpenSmock/Pyramid/assets/34318678/099f25fc-74bd-477f-bef0-2ad7d47db10d) From 12859125f8acfa2c3130a06da10f00da204db1f6 Mon Sep 17 00:00:00 2001 From: Pierre Laborde <49183340+labordep@users.noreply.github.com> Date: Sat, 26 Aug 2023 17:38:35 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index cb302dbe..0b509a57 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,17 @@ Use the `Pyramid preview` tab to test an existing project. https://github.com/OpenSmock/Pyramid/assets/49183340/12a916e5-06d1-426f-954c-2e4e911475e1 +### Tips + +To edit a `BlElement` instance or a `BlSpace` instance into Pyramid : + +```st +element editWithPyramid. +space editWithPyramid. +``` + +You can edit in Pyramid an opened BlSpace with `F12` keyboard shortcut, for that open a BlElement with `openInNewSpaceWithPyramidShortcut`. + ## Dependencies ![image](https://github.com/OpenSmock/Pyramid/assets/34318678/099f25fc-74bd-477f-bef0-2ad7d47db10d) From 2f3ee017adbf091c4ed5f5c94b5cc61fc82a4ecc Mon Sep 17 00:00:00 2001 From: Pierre Laborde <49183340+labordep@users.noreply.github.com> Date: Sat, 26 Aug 2023 18:10:01 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b509a57..20aa6755 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Pyramid is a User-Interface (UI) editor. -![image](https://github.com/OpenSmock/Pyramid/assets/49183340/d94c88d4-5535-4f3d-a898-dc0b8effdb1b) +![image](https://github.com/OpenSmock/Pyramid/assets/49183340/d5b6957d-1015-4726-94b5-58ad1e62cfc9) Pyramid is a WYSIWYG application (What You See Is What You Get) in other terms it allows you to visually design the expected outcome. From 21edfdeb4bac641919174352e0ab548cd1011725 Mon Sep 17 00:00:00 2001 From: Pierre Laborde <49183340+labordep@users.noreply.github.com> Date: Sat, 26 Aug 2023 18:15:53 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 20aa6755..029406b3 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ Pyramid is a WYSIWYG application (What You See Is What You Get) in other terms i Pyramid helps you to produce final UI using Bloc library (and also Toplo). +You can add plugins into Pyramid to extents the editor capacities or create [your own plugin](https://github.com/OpenSmock/Pyramid/wiki/Ajouter-un-nouveau-plugin-a-Pyramid) with your specifics functions ! + ## How to get Pyramid You can load the last stable version of Pyramid or the development version. The Development version can provide the new incoming functionalities but can be unstable. @@ -84,6 +86,11 @@ space editWithPyramid. You can edit in Pyramid an opened BlSpace with `F12` keyboard shortcut, for that open a BlElement with `openInNewSpaceWithPyramidShortcut`. +## Plugins + +![image](https://user-images.githubusercontent.com/49183340/263474758-37833c2b-f7ad-4b46-ab58-cb3d92c28413.png) +- [FigmaToWorld](https://github.com/OpenSmock/Pyramid-Plugins-FigmaToWorld) plugin provide capacities to import projects designed with [Figma](https://www.figma.com) + ## Dependencies ![image](https://github.com/OpenSmock/Pyramid/assets/34318678/099f25fc-74bd-477f-bef0-2ad7d47db10d)