Clarifying developer setup instructions
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 65/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Lĩnh vực
- build-system, developer-experience, documentation
Hướng nghiên cứu
Bắt đầu với phần “Development Environment” trong readme.md và đối chiếu phần này với README, build64-nvda-addon.sh, script build không phải 64-bit và .gitignore. Thực hiện lại các bước cargo build và scons đã nêu, sau đó ghi lại các điều kiện tiên quyết đã được xác nhận, cách sử dụng script và đường dẫn Rules được tạo. Công việc được xem là hoàn tất khi một người mới có thể thiết lập và build addon mà không còn những câu hỏi chưa được giải đáp trong issue này.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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`?)
- Ngôn ngữ chính
- Python
- Star
- 10
- Fork
- 10
- Merge trung bình
- 10 giờ 40 phút
- Pull request đã merge (30 ngày)
- 4
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của daisy/MathCATForPython
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
daisy/MathCATForPython#105 · 2 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 65/100
daisy/MathCATForPython#112 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 62/100
daisy/MathCATForPython#111 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
daisy/MathCATForPython#110 ·
-
daisy/MathCATForPython#104 · 1 người được giao ·
Tất cả issue của daisy/MathCATForPython
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
learningequality/ricecooker#747 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
run-llama/llama_index#23199 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
KhronosGroup/glTF-Blender-IO#2769 ·