Clarifying developer setup instructions
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 65/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
Línea de trabajo
Comienza con la sección „Development Environment“ de readme.md y compárala con README, build64-nvda-addon.sh, el script de compilación que no es de 64 bits y .gitignore. Reproduce los pasos indicados de cargo build y scons, y documenta después los prerrequisitos confirmados, el uso de los scripts y la ruta de Rules generada. Se considera terminado cuando una persona nueva puede configurar y compilar el complemento sin las preguntas que siguen sin respuesta en este issue.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
-
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. - 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}, notC:/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:
- Installed python 3.14.7-64bit via Python installer (instead of 3.11-32bit)
- Set up venv and installed listed modules
- Cloned MathCAT and NVDA git repos as siblings to MathCATForPython.
Additional prereqs not covered in that document:
- 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?)
pip install scons. Maybe this one was supposed to be outside the venv, but I installed it in the venv for now.pip install markdownas 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`?)
- Lenguaje dominante
- Python
- Estrellas
- 10
- Forks
- 10
- Merge medio
- 10 h 40 min
- PR fusionados (30 d)
- 4
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de daisy/MathCATForPython
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
daisy/MathCATForPython#105 · 2 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
daisy/MathCATForPython#112 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
daisy/MathCATForPython#111 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
daisy/MathCATForPython#110 ·
-
daisy/MathCATForPython#104 · 1 asignado ·
Todos los issues de daisy/MathCATForPython
Issues similares
-
货币战争手改优先级配置缺少列表元素类型校验(P3) Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
syfoud/Simulated_Scepter#172 ·
-
A cancelled tests run makes the coverage comment workflow fail and reports it as a red check on main Abiertoarea: ci bug perceived difficulty: 3
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Nitjsefnie-Harness-Commons/daedalus#921 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
EleutherAI/lm-evaluation-harness#4207 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
ClickHouse/clickhouse-connect#1057 ·