openframeworks/openFrameworks

Need help checking / updating setup guides

ofTheo opened this issue · 18 comments

Hey all!

Now 0.12.0 is out we'd love to get a little help checking and updating the current setup instructions for each platform.

We're looking for volunteers to review a current setup guide. eg: Xcode or Raspberry Pi and make suggestions / changes so it works with the current IDE and 0.12.0.

Guides:

Drops/Adds:

If you are interested in helping with a guide just drop a note in this issue.

The markdown files for the guides currently live here:
https://github.com/openframeworks/ofSite/tree/master/content/setup

A PR to the ofSite is ideal, but feel free to share a gist or by any means and we'll get it updated.

Many thanks!

Yeah absolutely. I'll do the android one as apart of the new updates next week

@ofTheo
I've started to update MSYS2 setup intructions.
I'll PR once ready !

I've tested with 0.11 on Pi zero2, and PI4, found slight misalignements, will check this one this week and report.

The Emscripten guide is still working for Linux and the Windows Subsystem for Linux. But I can check it again.
VS does not work for me yet: #7484

Thanks everyone!
Adding a note, that we should make clear minimum OS support ( ie: Ubuntu 18.04 / GCC 8.3, macOS 10.15 etc ).

For Emscripten I would add a note how to use multithreading...

Xcode is done thanks to @alptugan 🎉
openframeworks/ofSite#807

Xcode is done thanks to @alptugan 🎉 openframeworks/ofSite#807

The image links seem to be broken. It looks fine in github, btw

ahh I think if you look at the way the translated versions are the files need to be linked like this:

![install dialog for the command line tools](/setup/xcode/install-dialog.png)

which corresponds to the file on the site:

https://openframeworks.cc/setup/xcode/install-dialog.png

so I think you would need to add:
/setup/xcode to the image url ( which makes it not render in the markdown :P )

I just did a test to see:
openframeworks/ofSite@194842e

Actually ignore that @alptugan - I think the files are just not getting synched over.
I'll try and fix that.

It's working now @alptugan - but I think we'll need some of those images a bit smaller :)
https://openframeworks.cc/setup/xcode/

@ofTheo my bad :) because of retina display. I resize and PR

Do you need help checking something on Windows?

OK, @ofTheo , here are some things I noticed:

Install

VS install is the same for 2022. Just that the components are newer:
image

When I open an sln file in the examples, I get "One or more projects in the solution were not loaded correctly" message. It looks like the directory was set to be the zip file that oF was originally downloaded in:
image

Using the Project Generator fixes this.

However, the Project Generator also seems to generate projects with the v142 toolset, so you always have to retarget the solution. A newly generated project (or a preexisting solution from the examples folder) will give you the prompt for this, but when updating a project with the Project Generator (to add/remove addons), you need to right-click on the Solution in the Solution Explorer and choose Retarget Project:
image

A section introducing the Project Generator seems like it'd be helpful. I guess bypassing it could avoid the the need to retarget(?), but it's otherwise a useful tool, so probably worth mentioning.

Video Codecs

Is K-Lite still needed on Windows with the new version? I thought there was a big change with the way Windows video playback is handled in the new version...

openFrameworks plugin for Visual Studio
Opening Extensions>Manage Extensions and searching in the Online section reveals no openFrameworks plugin (I've also never used this iirc so it doesn't seem necessary)

image

Thanks @diemildefreude !

When I open an sln file in the examples, I get "One or more projects in the solution were not loaded correctly" message. It looks like the directory was set to be the zip file that oF was originally downloaded in:

Did you run the examples from the zip file by any chance?
I think this could occur if you double click on the zip and open it like a folder instead of expanding it to a new directory.

However, the Project Generator also seems to generate projects with the v143 toolset, so you always have to retarget the solution.

Yes, this is definitely intended behavior but maybe we could make sure it happens when you update a project it still asks to convert / retarget solution. That might just be a matter of removing a VS file in the project directory.

Video Codecs

That's right it's no longer needed for most video files.

openFrameworks plugin for Visual Studio

Definitely can be removed as well!

Thank you!!

Did you run the examples from the zip file by any chance?
I think this could occur if you double click on the zip and open it like a folder instead of expanding it to a new directory.

@ofTheo I copied the oF folder from inside the zip into a folder outside of the zip file and then opened the solutions there.