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

[Documentation] Improve PyCharm instructions for macOS/Linux #3431

Open
vadi2 opened this issue Feb 18, 2024 · 1 comment
Open

[Documentation] Improve PyCharm instructions for macOS/Linux #3431

vadi2 opened this issue Feb 18, 2024 · 1 comment
Labels
documentation Issue with wiki or docstrings. help wanted We specifically want more help on this one.

Comments

@vadi2
Copy link

vadi2 commented Feb 18, 2024

Existing page / new

https://www.evennia.com/docs/latest/Coding/Setting-up-PyCharm.html

Documentation issue

It would be great to see the documentation updated to handle modern PyCharm as well as running the setup on macOS and Linux. The following points need to be addressed:

  • when PyCharm is first launched, it will offer to create a evenv. This should be declined by the user and is not mentioned in the documentation
  • \<yourrepo\>\evenv\Scripts\evennia_launcher.py is not a valid location on macOS/Linux, rather it is evenv/bin/evennia. It is a an open question is it is valid on Windows too.
  • even after evennia is running, breakpoints do not take hold in PyCharm. Unsure about this.

Suggested change

An update to the documentation to make it more current would be welcome.

@vadi2 vadi2 added the documentation Issue with wiki or docstrings. label Feb 18, 2024
@Griatch Griatch added the help wanted We specifically want more help on this one. label Feb 18, 2024
@ChrisLR
Copy link
Contributor

ChrisLR commented Feb 25, 2024

I will take a look soon-ish.
A few notes before I do

  • Creating a new venv can be the right move if you are setting a new project and not following the guidelines.
  • Links will vary from OS to OS and from install to install, I can give out a few examples but it will never be set in stone
  • Breakpoints will only work when you attach to the proper process or if you are running tests, there's a few tricks to it, I will update that part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue with wiki or docstrings. help wanted We specifically want more help on this one.
Projects
None yet
Development

No branches or pull requests

3 participants