Skip to content

Commit

Permalink
Fixed a few links and wording in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leap71 committed Oct 17, 2023
1 parent 354a34b commit 496b81e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions Documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,16 @@ And run it.

![image-20231014184919894](images/image-20231014184919894.png)If everything is right, a window will open, showing you a few spheres that are combined using Boolean operations. You can click and drag in the viewer to rotate, scroll to zoom, and use the cursor keys to rotate by 15º. The viewer is basic but functional.

If you are not seeing this window, you can check out the console window at the bottom of Visual Studio to see any error messages. These messages are also written to **PicoGK.log** in your Documents folder (you can change the location if you don't like that). One thing you may have to do on Mac is adjust the security settings, so PicoGK can load the pre-compiled PicoGKRuntime. [If you want to compile it yourself, here are the instructions](Compiling_PicoGKRuntime.md).
If you are not seeing this window, you can check out the console window at the bottom of Visual Studio to see any error messages. These messages are also written to **PicoGK.log** in your Documents folder (you can change the location if you don't like that). One thing you may have to do on [Mac is adjust the security settings](../Runtime/README.md), so PicoGK can load the pre-compiled PicoGKRuntime. [If you want to compile it yourself, here are the instructions](Compiling_PicoGKRuntime.md).

[Drop us a note in the discussion section of this repository](https://github.com/leap71/PicoGK/discussions), if you have any issues, and we will do our best to help. The most common problem is that the PicoGK Runtime library cannot be found. Double check if you copied it to the right system folder.

Congratulations, you can now code in PicoGK!

Check out the other examples from the Examples subdirectory of PicoGK. A fun way to work your way through is by simply typing a dot behind the PicoGKExamples namespace ID, as below, and you will see all the options. Just don't forget to add "Task" at the end.

If you dive into the code, you will see that it's super simple to create interesting things, even with the basic PicoGK functions.
If you look at the code, you will see that it's super simple to create interesting things, even with the basic PicoGK functions.

<img src="images/image-20231014185209784.png" alt="image-20231014185209784" style="zoom:50%;" />
If you want to seriously dive in, [you should work using the LEAP 71 Shape Kernel.](https://github.com/leap71/LEAP71ShapeKernel) and build your [Computational Engineering Models](https://leap71.com/computationalengineering/) on top.

If you want to seriously dive in, [you should work using the LEAP 71 Shape Kernel.](https://github.com/leap71/ShapeKernel) and build your [Computational Engineering Models](https://leap71.com/computationalengineering/) on top.

If you'd like to dive into the details of compiling and developing the [PicoGKRuntime, you will find a setup guide here](Compiling_PicoGKRuntime.md).
If you'd like to jump into the details of compiling and developing the [PicoGKRuntime, you will find a setup guide here](Compiling_PicoGKRuntime.md).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ We encourage other software vendors to support the PicoGKRuntime API and release

**PicoGK**, the C# code, which you have open right now, provides rich functionality based on the PicoGKRuntime interface. It makes it as simple as possible to build computational geometry.

You will, however, ususally not use PicoGK directly to build Computational Engineering Models. We encourage you to look at our other open-source project, the [LEAP 71 ShapeKernel](https://github.com/leap71/ShapeKernel), which was written by Josefine Lissner, and forms the basis of all objects we create at LEAP 71 and uses PicoGK as the foundation.
You will, however, ususally not use PicoGK directly to build Computational Engineering Models. We encourage you to look at our other open-source project, the [LEAP 71 ShapeKernel](https://github.com/leap71/LEAP71ShapeKernel), which was written by Josefine Lissner, and forms the basis of all objects we create at LEAP 71 and uses PicoGK as the foundation.

[Please head over to our documentation, for how to get started with PicoGK.](Documentation/README.md)

0 comments on commit 496b81e

Please sign in to comment.