{"id":21711841,"url":"https://github.com/gemarcano/libctrelf","last_synced_at":"2025-04-12T17:41:49.995Z","repository":{"id":75914386,"uuid":"67672025","full_name":"gemarcano/libctrelf","owner":"gemarcano","description":"Nintendo 3DS ELF file support library","archived":false,"fork":false,"pushed_at":"2023-05-21T06:54:18.000Z","size":28,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T12:02:57.285Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gemarcano.png","metadata":{"files":{"readme":"README","changelog":null,"contributing":null,"funding":null,"license":"COPYING.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-08T05:39:32.000Z","updated_at":"2017-09-26T09:27:22.000Z","dependencies_parsed_at":null,"dependency_job_id":"de681177-cca8-4660-98ad-0736c622950c","html_url":"https://github.com/gemarcano/libctrelf","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemarcano%2Flibctrelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemarcano%2Flibctrelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemarcano%2Flibctrelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gemarcano%2Flibctrelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gemarcano","download_url":"https://codeload.github.com/gemarcano/libctrelf/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248608063,"owners_count":21132656,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T23:30:05.553Z","updated_at":"2025-04-12T17:41:49.989Z","avatar_url":"https://github.com/gemarcano.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"________________________________________________________________________________\n\nlibctrelf\n\nCopyright 2016 Gabriel Marcano\n________________________________________________________________________________\n\n\n--------------------------------------------------------------------------------\nLicensing\n--------------------------------------------------------------------------------\n\nThis project is licensed under the GPL 2 or later licenses, at your choice.\nRefer to COPYING for more licensing information and for the licensing for the\ncode borrowed from other sources.\n\n\n--------------------------------------------------------------------------------\nAbout\n--------------------------------------------------------------------------------\n\nThis library is meant to be a collection of functions to simplify reading ELF\nfiles.\n\nNote this library is still in active development and the API is not considered\nstable. Breaking changes will be mentioned in commits at the very least.\n\n\n--------------------------------------------------------------------------------\nDependencies\n--------------------------------------------------------------------------------\n\n - Autotools in general. These are used to create the build scripts.\n\n--------------------------------------------------------------------------------\nCompiling\n--------------------------------------------------------------------------------\n\nThe Autotools setup assumes that devkitarm is already in the PATH.\n\n # this following line is if the 3ds compiler isn't in the path\n export PATH=${PATH}:${DEVKITPRO}/bin:${DEVKITARM}/bin\n autoreconf -if\n ./configure --host arm-none-eabi --prefix=[lib install path]\n make\n\nExample:\n  export PATH=${PATH}:${DEVKITPRO}/bin:${DEVKITARM}/bin\n  autoreconf -if\n  ./configure --host arm-none-eabi --prefix=\"$HOME/.local/usr/arm-none-eabi-9/\"\n  make -j10\n\n\n--------------------------------------------------------------------------------\nInstallation\n--------------------------------------------------------------------------------\n\nTBD. This library is built using Autotools, so it supports the 'make install'\nand 'make uninstall' targets. Be sure to set --prefix when calling configure\nif either of the preceeding targets will be used, else by default the generated\nMakefile will install to /usr/local/ (most likely)) !\n\nExample (after having compiled):\n  #this will install to the directory specified in prefix, or /usr/local/ if\n  #prefix isn't defined (most likely)!\n  make install\n\n\n--------------------------------------------------------------------------------\nUsage\n--------------------------------------------------------------------------------\n\nDepending on where the library is installed, one may need to use -L in one's\nprojects to point the compiler to find the library, then use -lctrelf to cause\nthe linker to link in the static library.\n\nExample:\n  arm-none-eabi-gcc -I$HOME/.local/usr/arm-none-eabi-9/include \\\n    -L$HOME/.local/usr/arm-none-eabi-9/lib -Os -Wall -Wextra -Wpedantic hello.c\\\n    -lctrelf\n\nOne setup that is recommended is to export a variable such as, CTRARM9, to point\nto the root of the prefix where libctr9 is installed. This way, it is easier to\npoint to the lib and include directories (such as by using $CTRARM9/include and\n$CTRARM9/lib).\n\n\n--------------------------------------------------------------------------------\nDocumentation (TODO)\n--------------------------------------------------------------------------------\n\nThis project uses Doxygen markup in order to facilitate the generation of\ndocumentation, which should be found when generated in the doc/ folder. Each\nheader in the include/ directory should also be well documented and can be used\nas reference for programming.\n\nIn addition, some documentation is hosted in GitHub pages:\n\thttps://gemarcano.github.io/ctrelf/\n\n\n--------------------------------------------------------------------------------\nTesting (TODO)\n--------------------------------------------------------------------------------\n\nThis project does include a homegrown unit testing framework and some unit tests\nfor this library. See the test/ directory for more information. Note that the\nunit testing payload WILL write to NAND (in theory writes to areas that are\nunused) as a part of unit testing.\n\nTo compile it, change directory to test/, then execute `make test`. The\ngenerated test.bin is an A9LH compatible binary.\n\n\n--------------------------------------------------------------------------------\nIssues/Bugs\n--------------------------------------------------------------------------------\n\nPlease report these to the issue tracker at the repository, and these will be\naddressed as soon as possible, if not at least acknowledged. The more detailed\nthe reports, the more likely they are to be addressed quickly. In particular,\nthe following information can be quite useful when debugging bugs:\n\n - Type of 2/3DS system\n - Operating system being used to compile\n - Release/commit of library in use\n - Steps to reproduce issue\n - Expected behavior\n - Actual behavior\n - ARM9 entry point\n - Any modifications to the library, or extensions\n\n\n--------------------------------------------------------------------------------\nContributing\n--------------------------------------------------------------------------------\n\nPull requests are welcome. All requests will be looked at in detail, and must be\ndocumented in a similar fashion as the rest of the code for this project. In\nparticular, it is unlikely (but not impossible) that code that emmits warnings\nwith the warnings in use by this library would be merged without first fixing/\naddressing what is causing the warnings to be emitted.\n\n\n--------------------------------------------------------------------------------\nCredits\n--------------------------------------------------------------------------------\n\n - #3dshacks @ Rizon for starting me on my path to 3DS homebrew development\n - #Cakey @ Freenode for the continued development support\n - #3dsdev @ EFNet for the occasional help answering questions\n - dark_samus for helping to develop A9LH stuff in Cakey, which drove for the\n    development of this library\n - Delebile for publishing the public arm9loaderhax implementation, making using\n    and testing this library possible (or less of a pain)\n - Aurora, et. al (you know who you are, I hope) for for general development\n    help and brainstorming\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgemarcano%2Flibctrelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgemarcano%2Flibctrelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgemarcano%2Flibctrelf/lists"}