We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Updated 2. Dev Setup (markdown)
Minor visual changes, mostly to make key points stand out in Contributing Code section
Add info about restarting VSCode after running DevEnvSetup to make sure it is run from the right directory
Changing platform names in docs explaining VSCode configuration to simply be bolded rather than headers so that they don't appear in the generated TOC
Using explicit HTML tags rather than octothorpe to create headings that don't appear in the page's TOC
Punctuation tweak
Updates to streamline presentation of platform-specific instructions, as well as to make VSCode-centric instructions more explicit
Added link to GitLens Branches View docs
Added further information for how to create feature branches, either using the builtin VSCode source control tools or using GitLens
Reverting position of instructions for how to install MSVC compiler toolchain on Windows, but keeping note about running VSCode from the Developer Command Prompt to be able to use MSVC cl down under the instructions for installing VSCode for Windows
Minor fix to formatting in install instructions for MinGW-w64. Updated info for Python linting and formatting for the TestSupport scripts section
Updating Windows instructions to install MinGW-w64 using UCRT (see Issue #102)
Warning about how to run devEnvSetupScript.sh on Windows
Minor tweak to devEnvSetupScript.sh instructions (Since the script uses relative paths that assume it's being run from within edge-addition-planarity-suite/devEnvSetupAndDefaults/ directory)
Windows setup steps have been tested on a Windows 11 PC
Verified e2e Windows instructions in Windows 22H2 VM with MinGW32 compiler toolchain; checked debugging C and Python sources works.
Fleshing out the Debian 12.7.0 instructions, in particular those required to build Python from source; verified that after all steps, was able to debug planarity executable and one of the python TestSupport scripts
Verified macOS instructions in Sequoia 15.0 VM
First draft complete; final verification of setup steps forthcoming
Removing references to Eclipse IDE setup, reorganizing so that platform-dependent setup instructions are in their proper section
Must tackle #103 to make these instructions coherent
Trying to massage exising documentation from the README.md for working with Eclipse into this docs page
Removing instructions pertaining to setup of clang installed via homebrew, pending #111
Small tweaks, but most importantly need to verify the compiler toolchain setup on MacOS
Fleshed out VSCode instructions for debugging C/C++ and Python, copied Eclipse instructions from README.md
Adding preliminary instructions for Windows MinGW gcc and MSVC cl. Linking to appropriate wiki pages for Python debugging, linting, and formatting.
Adding Python 3.12 install instructions for MacOS Sequoia (15.0); decided to include instructions for how to use homebrew to install Python 3.12, even though it is significantly more brittle and fraught than running the macOS universal2 installer
Added Python 3.12 installation instructions for Windows 10 with links to appropriate wiki pages after confirming details on Windows 10 22H2 virtual machine