Skip to content

Write setup instruction wiki page #30

@wbkboyer

Description

@wbkboyer

Create a new wiki page to support PyPI consumers as well as for developer enablement.

Include instructions for installing planarity from pip, with especial instructions for Windows users who would prefer to use MinGW-w64 gcc as their compiler.

For developer setup steps, include instructions for Windows (MSVC cl and MinGW-w64 gcc), MacOS (clang), and Debian Linux (gcc) for how to:

  • install a compiler toolchain,
  • install the latest Python (presently 3.14.3),
  • install VSCode (IDE chosen for multi-platform support and diverse set of extensions)

Then regardless of platform, include instructions for VSCode configuration (i.e. extensions to install), as well as recommended steps for working with and contributing to the code (i.e. process to fork repo, (optionally) create a branch with a sensible name, build code from source locally, and create PR)

This page should also likely be the home of the process by which core planarity developers first publish to TestPyPI (see #28 ) before cutting a release to be published to PyPI.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions