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

docs: add complete build123d + visualization demo via ocp_vscode "standalone" mode #793

Open
jdegenstein opened this issue Nov 17, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jdegenstein
Copy link
Collaborator

Now that ocp_vscode supports use in a regular browser (and not strictly bound with VSCode), it is much easier to explain how one could simply:

  1. pip install build123d ocp_vscode
  2. execute python -m ocp_vscode
  3. open http://127.0.0.1:3939/viewer in a suitable browser
  4. execute a python file with necessary build123d and ocp_vscode imports and show statement

As a way to get users "up and running quickly" I propose something similar to the above is added to the build123d docs (with appropriate links/caveats back to the ocp_vscode repo/docs). Further I propose that a screenshot is added to show what this could look like (maybe with vim + chrome, or something similar).

@jdegenstein jdegenstein self-assigned this Nov 17, 2024
@gumyr gumyr added the documentation Improvements or additions to documentation label Nov 18, 2024
@gumyr gumyr added this to the Not Gating Release 1.0.0 milestone Nov 18, 2024
@gumyr
Copy link
Owner

gumyr commented Nov 18, 2024

+1

@jdegenstein
Copy link
Collaborator Author

Screenshot for the docs [using Ubuntu 20.04, gedit, gnome-terminal, ipython and firefox]:

image

@gumyr
Copy link
Owner

gumyr commented Nov 20, 2024

Nice

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

No branches or pull requests

2 participants