| 1 | == Haikuporter recipe task == |
| 2 | |
| 3 | Haikuporter is our tool to fetch, patch and build source code and create Haiku packages that can then be put into a repository to be installed by the user via HaikuDepot. |
| 4 | For this kind of GCI task you have to create a haikuporter recipe, which is a kind of script that automates this process. |
| 5 | |
| 6 | === Required skills === |
| 7 | |
| 8 | Depending on the targeted software you may need these skills: |
| 9 | |
| 10 | * Some knowledge of C, C++, git and bash |
| 11 | * Knowledge of the GNU autotools and/or cmake |
| 12 | * The package may require some patching to get it to work on Haiku |
| 13 | |
| 14 | === Required setup === |
| 15 | |
| 16 | For this task you need to have: |
| 17 | * A [http://download.haiku-os.org/nightly-images/x86_gcc2_hybrid/ nightly Haiku] installed. |
| 18 | * Haikuporter installed and the haikuports bitbucket cloned, see the "[https://github.com/haikuports/haikuports/wiki HaikuPorter wiki page]. |
| 19 | |
| 20 | === Creating and submitting your recipe === |
| 21 | |
| 22 | * Before submitting your work, make sure to test your recipe by creating a hpkg package from it with haikuporter. Double-clicking the hpkg file will open it in HaikuDepot to inspect its contents. |
| 23 | * Take care to include all required licenses and copyright entries. |
| 24 | * Submit your work as pull request to haikuports github (see "[https://github.com/haikuports/haikuports/wiki/DevelopmentModel DevelopmentModel]" in the wiki). |
| 25 | * Submit a screenshot of the package's contents and (if applicable) the running application to the GCI task. |
| 26 | |
| 27 | === Recommended reading and help === |
| 28 | |
| 29 | * Most importantly: all of the [https://github.com/haikuports/haikuports/wiki HaikuPorter wiki. |
| 30 | * In addition to the wiki, studying working recipes in the haikuports tree can be a big help. |
| 31 | * The [https://www.haiku-os.org/docs/userguide/en/contents.html Userguide] and [https://www.haiku-os.org/docs/welcome/welcome_en.html Welcome] page and the [http://www.haiku-os.org/guidesHaiku Guides] can answer many questions you may have, esp. if you're new to Haiku. |
| 32 | * Besides requesting assistance by leaving a comment in this task, a trip to the main [http://www.haiku-os.org/community/irc IRC channel #haiku] may prove to be quicker (consider possible timezone differences with your mentors). |