search

RomanKubiak / ctrlr

Ctrlr
BSD 3-Clause "New" or "Revised" License
497 stars 58 forks source link

Not an issue: can you explain how I can contribute by adding the help text for all properties? #108

Open dobo365 opened 3 years ago

dobo365 commented 3 years ago

@RomanKubiak Can you explain me how I can contribute by adding the help text for all properties? We have nice links but they don't show anything. There are still properties I don't know what they are used for. For the ones I'm using I would gladly support you by writing the help texts.

I think that the help text popup / window should show 3 things:

What do you think? I have VS2019 but now also 2010. If you indicate which file to adapt, I can do it then send it to you. Maybe that you embedded the explanations within each .h or .cpp file? There is also the github Pull requests but I don't know how this is working. No problem to use that instead if you explain me how. Once I will have done one or two explanation texts and that the result is satisfactory then I can do the other ones gradually.

RomanKubiak commented 3 years ago

All properties are described in a XML file https://github.com/RomanKubiak/ctrlr/blob/master/Source/Resources/XML/CtrlrIDs.xml if you think there is something missing ore something could use better language, just edit that file. If you wan to add additional fields that should be displayed in some other manner just add another XML property like description="" or url="" or whatever. Then a PR would be the best thing to do here, but if you are not familiar with all that github stuff, just send the file to me or attach it here

dobo365 commented 3 years ago

Excellent. I'll do that and then you could do a screenshot so I can see how it displays. In 5.3.201, nothing is displayed when you click on the property name so I have no idea how it will look like and the eventual display restrictions.

dobo365 commented 3 years ago

FYI, I forked Ctrlr in my VS2019 and created a new branch "goodweather_branch" (don't know what the best name can be... at least you can see it's from me). I found the file so I can edit it. Once edited, I read I can do a pull request.

Q: in which version can I see this help text working so I have an idea how it looks? Q: is there a way to get it working on my PC for testing? I guess I must build it in my VS2019 and you said it was not ready for the moment (only on Linux), right? I'll try 551 on Linux to check this. Can you provide me some screenshot of this help screen?

RomanKubiak commented 3 years ago

i'm using VS2017 community. But first you need to compile Projucer so that the XML gets converted to a source code file, Projucer is in ctrlr/JUCE/extras/Projucer you need to the open ctrlr/Ctrlr.jucer and re-save the projcet it will re-generate all needed files and you can rebuild ctrlr. I know it's a bit complicated but it lets me keep all resource files in the binary instead of some external files

shooking commented 3 years ago

hi @dobo365 (Mr Goodweather). Hopefully not so tangential but if you dont have a Linux box perhaps you have a decent Mac/Windows box where you could run VirtualBox/vmWare and create a Linux? Alternatively I am doing my dev on a Raspberry Pi4 8Gb. £100 for dev env ... well pleased with it especially as I want to use it with Ctrlr and a 21.5" Touchscreen.

If you decide to go down the Pi route and want any help please ping me or check out some YT's I've made on building Ctrlr from source on Pi4.

I also made new video on Dexed - this is important because for that I had to build Projucer on Pi4 .. and NOW I can generate proper Pi4 makefiles for Ctrlr ... none of this hacking makefiles :-)

Best regards Steve (shooking)

shooking commented 3 years ago

i'm using VS2017 community. But first you need to compile Projucer so that the XML gets converted to a source code file, Projucer is in ctrlr/JUCE/extras/Projucer you need to the open ctrlr/Ctrlr.jucer and re-save the projcet it will re-generate all needed files and you can rebuild ctrlr. I know it's a bit complicated but it lets me keep all resource files in the binary instead of some external files

Hi @RomanKubiak - I only recently got Projucer working - built it on Pi and now I can finally see Ctrlr is a JUCE app - not sure why I just didnt get this.

1 - if I open it I can generate a new build for Raspberry Pi - works. 2 - however, when I tried this on Linux I build Projucer, ran it ... was forced to create an account on JUCE. Then Projucer complained that the PATH was incorrect ... now I can see how to "fix" this - and yet I cannot see how to fix it. What I mean is say I wanted to checkin a PI build, right now my path would be /home/pi/Software/ctrlr .. but well that wouldnt be correct for the next person who used it (except possibly on a Pi).

How to make variable relocatable? (hope it makes sense what I am saying - one can just not set it - and maybe that's the solution??)

RomanKubiak commented 3 years ago

You can run projucer on you normal machine. It does not need to run on the target machine. Try to use relative paths not absolute paths, like ../../Source/etc no /home/me/pi this will be better

shooking commented 3 years ago

Awesome. Will do.

On Thu, 7 Jan 2021, 10:32 Roman Kubiak, notifications@github.com wrote:

You can run projucer on you normal machine. It does not need to run on the target machine. Try to use relative paths not absolute paths, like ../../Source/etc no /home/me/pi this will be better

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/RomanKubiak/ctrlr/issues/108#issuecomment-756031586, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFO7EV3E5HO635PVC7KJIWLSYWEUTANCNFSM4VRBMSNA .

dobo365 commented 3 years ago

i'm using VS2017 community. But first you need to compile Projucer so that the XML gets converted to a source code file, Projucer is in ctrlr/JUCE/extras/Projucer you need to the open ctrlr/Ctrlr.jucer and re-save the projcet it will re-generate all needed files and you can rebuild ctrlr. I know it's a bit complicated but it lets me keep all resource files in the binary instead of some external files

@RomanKubiak I have now recreated a VS2019 solution based on your current Github repository with 5.5.9 I opened VS2019 ctrlr.sln but then didn't see the JUCE folder in the solution tree. Closed that then when navigating to the folder where the ep has been copied I saw the structure as in Github and the Juce folder. Cannot work with ctrlr.jucer file in VS. Do I need to open it in Projucer so that it replaces the files within my copied folder structure in my PC? Then after that, open VS2019/ctrlr.sln ? Thx

RomanKubiak commented 3 years ago

Well JUCE is part of cttrlr but if you re-save in projucer on your computer i think it needs the path to JUCE as an absolute path, this is a setting of Projucer (file->global paths i think) i always shipped with my paths embedded in there (i use ~/devel/ctrlr on osx/linux abd c:\devel\ctrlr on windows)