Updates to documentation
Opened this issue · 0 comments
Hi @thomthom,
Just came to this for first time. Functionality is great, but would you be able to update the Setup docs a bit? Compared to TestUp I found it really hard to know where to start!
I made a PR with some suggestions #5
(sorry I don't know how to squash this to 1 commit through Github UI)
Installation
I couldn't see an RBZ, so I took a punt and downloaded the .zip from Code, had a look around inside and found the src folder had what looked like an extension structure (speedup.rb and speedup folder), so I manually dropped those into my Plugins folder and restarted SU.
Setup
It wasn't entirely clearly what to do next!
Eventually I guessed that the Setup menu item needed to be run
Extensions > Developer > SpeedUp > Setup
and in the Ruby Console I got:
In SU 2021:
Setting up SpeedUp...
Installing pre-compiled rubo-prof...
> Checking for compatible version...
> Source: ~/Library/Application Support/SketchUp 2021/SketchUp/Plugins/speedup/precompiled-gems/Ruby27/mac/Gems (Exists: true)
> Target: ~/Library/Application Support/SketchUp 2021/SketchUp/Gems (Exists: false)
> Installing...
> Loading...
Done!
In SU 2022:
Setting up SpeedUp...
Installing pre-compiled rubo-prof...
> Checking for compatible version...
> Source: ~/Library/Application Support/SketchUp 2022/SketchUp/Plugins/speedup/precompiled-gems/Ruby27/mac/Gems (Exists: true)
> Target: ~/Library/Application Support/SketchUp 2022/SketchUp/Gems (Exists: false)
> Installing...
> Loading...
Ignoring ruby-prof-1.4.3 because its extensions are not built. Try: gem pristine ruby-prof --version 1.4.3
Done!
Interpreting results
Would be really nice to have some docs on how to interpret the results and where to dig further - maybe that is longer-term wishlist
Extensions > Developer > SpeedUp > Setup is now greyed-out