Clarifying developer setup instructions

オープン
#115 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
65/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown, python, rust, shell

調査の方向性

readme.md の「Development Environment」セクションから始め、README、build64-nvda-addon.sh、64 ビット用ではないビルドスクリプト、.gitignore と比較します。記載されている cargo build と scons の手順を再現し、確認済みの前提条件、スクリプトの使用方法、生成される Rules のパスを文書化します。この issue で未回答の疑問を残さずに、新しいコントリビューターがアドオンをセットアップしてビルドできれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
10
フォーク
10
平均マージ
10時間 40分
マージ済み PR(30日)
4

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

daisy/MathCATForPython のほかの issue

daisy/MathCATForPython の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。