Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IDE setup instructions and comparison #2290

Merged
merged 8 commits into from
Jul 18, 2020
Merged

Conversation

karliss
Copy link
Member

@karliss karliss commented Jul 15, 2020

Your checklist for this pull request

Detailed description

Test plan (required)

  • Make sure there are no warnings when running make quick
  • Check that all links point to the expected page

Closing issues

@karliss
Copy link
Member Author

karliss commented Jul 15, 2020

TODO:

  • Make the marking of UI element paths consistent ✔️
  • Debugger Qt type visualization in VSCode ✔️

@karliss karliss marked this pull request as ready for review July 16, 2020 19:12
@karliss karliss requested a review from ITAYC0HEN July 16, 2020 19:14
Copy link
Member

@ITAYC0HEN ITAYC0HEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done! I love it <3

I would also add a .. note:: or similar to ask the community to add their own tips and gotchas from their experience with configuring the IDEs.

docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
There are no strict requirements for using a specific one for Cutter development.
Any IDE with good CMake integration should work well.

For most development builds unless you are working on packaging issues it is recommended to use ``CUTTER_USE_BUNDLED_RADARE2=ON`` Cmake option. It is the easiest way of ensuring that compatible r2 version is used and dealing with multiple r2 versions when working with multiple Cutter branches. On Linux in case of multiple r2 versions without ``CUTTER_USE_BUNDLED_RADARE2`` ``PKG_CONFIG_PATH`` environment variable can be used to select desired radare2 installation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using .. tip::, especially relevant with the CSS I added in the documentation PR

docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
docs/source/developers-docs/ide-setup.rst Outdated Show resolved Hide resolved
Copy link
Member

@ITAYC0HEN ITAYC0HEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants