AcademySoftwareFoundation / AcademySoftwareFoundation/OpenColorIO

Improve Windows build scripts and documentation

Offen
#1,867 9 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Build Issue Documentation good first issue help wanted
Vorherrschende Sprache
C++
Sterne
2.1k
Forks
503
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

As mentioned in [the Installation guide](https://opencolorio.readthedocs.io/en/latest/quick_start/installation.html), there are two .bat scripts available to help install prerequisites and build OCIO on Windows. These are helpful, however, there are some rough edges with these scripts. For example, some of the instructions are not clear about installing vcpkg. Additionally, instructions should be added for using the Community rather than the Enterprise edition of Visual Studio.

This issue is for someone to take a fresh look at installation on Windows, from the point of view of an inexperienced developer, and make some improvements. Some of the improvements could be to the documentation page and some could be in the .bat scripts themselves.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem Installationsleitfaden und prüfe die beiden Windows-.bat-Skripte, auf die er verweist. Überprüfe die Anweisungen zu vcpkg und Visual Studio Community aus der Perspektive eines unerfahrenen Entwicklers; abgeschlossen ist die Aufgabe, wenn die Dokumentation und Skripte einen klareren Installations- und Build-Pfad für Windows bieten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
build-system, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

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