Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Clarifying developer setup instructions

Ouverte
#115 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
65/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
markdown, python, rust, shell

Piste de recherche

Commencez par la section « Development Environment » de readme.md et comparez-la avec README, build64-nvda-addon.sh, le script de build non-64 bits et .gitignore. Reproduisez les étapes cargo build et scons indiquées, puis documentez les prérequis confirmés, l’utilisation des scripts et le chemin Rules généré. Le travail est terminé lorsqu’un nouveau contributeur peut configurer et builder l’addon sans les questions restées sans réponse dans cette issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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`?)

Langage dominant
Python
Étoiles
10
Forks
10
Merge moyen
10 h 40 min
PR mergées (30 j)
4

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de daisy/MathCATForPython

Toutes les issues de daisy/MathCATForPython

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.