Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Clarifying developer setup instructions

Offen
#115 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
65/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
markdown, python, rust, shell

Rechercherichtung

Beginne mit dem Abschnitt „Development Environment“ in readme.md und vergleiche ihn mit README, build64-nvda-addon.sh, dem Build-Skript für nicht-64-Bit und .gitignore. Führe die angegebenen cargo build- und scons-Schritte reproduzierbar aus und dokumentiere anschließend die bestätigten Voraussetzungen, die Verwendung der Skripte und den Pfad zu Rules, der generiert wird. Als erledigt gilt die Aufgabe, wenn ein Neuling das Add-on einrichten und erstellen kann, ohne die in diesem Issue offenen Fragen zu haben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Hi, I'm looking to contribute and I've (successfully?) set up a dev environment to build the MathCAT NVDA addon, but ran into a few questions. Once I've confirmed that I didn't do anything wrong, I'll try to update the readme's dev setup instructions with the additional prereqs I encountered.

@NSoiffer


I saw two scripts, build64-nvda-addon.sh and a non-64 counterpart. These files were updated within the past few weeks, possibly implying current use.

  1. PYO3_PYTHON_64=C:/Users/neils/AppData/Local/Python/pythoncore-3.13-64
    This path includes neils' username, making this script harder to use off of his machine.

  2. I'm more experienced with server-side development, so have more limited familiarity with setting up a Windows build env. This script is a bash script, and while apparently Windows PowerShell allows starting bash these days, it looks like it uses /mnt/C/Users/{username}, not C:/Users/{username}?

I'm unsure how I would run this script, even if I replaced neils' home path with something appropriate to my machine. (Start PowerShell, type bash, then execute the script? Execute directly from PowerShell? Some other terminal or otherwise?)
Are there additional prereqs to run this script on top of the ones covered below? At least build64 seems to point at two different python installs, if I'm reading correctly.

In the end I didn't use this script.


I mostly worked off of https://github.com/daisy/MathCATForPython/tree/main#development-environment

Prereqs approximately following the document:

  1. Installed python 3.14.7-64bit via Python installer (instead of 3.11-32bit)
  2. Set up venv and installed listed modules
  3. Cloned MathCAT and NVDA git repos as siblings to MathCATForPython.

Additional prereqs not covered in that document:

  1. Install rust (https://rustup.rs/) and MSVC prereqs. (You call out installing python, so it feels fair to me to call this out as well?)
  2. pip install scons. Maybe this one was supposed to be outside the venv, but I installed it in the venv for now.
  3. pip install markdown as an additional venv component, since the build seemed to need it?

My build process (no flags, unlike the bash scripts above):

cargo build
scons

Should I have been running any of the flags from the bash scripts?

Also, I've locally added addon/globalPlugins/MathCAT/Rules to the .gitignore file, since cargo build unzips the rules files from the base project into there. Considering that this isn't already in the checked-in .gitignore, am I doing something wrong? Or should I send a PR to update the checked-in file with that?

Also^2, should I fold [README](https://github.com/daisy/MathCATForPython/blob/main/README), which only describes running sconsinto the dev instructions from the more comprehensivereadme.md`?)

Vorherrschende Sprache
Python
Sterne
10
Forks
10
Ø Merge
10 Std. 40 Min.
Gemergte PRs (30 T.)
4

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus daisy/MathCATForPython

Alle Issues in daisy/MathCATForPython

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.