{"id":16717417,"url":"https://github.com/panglesd/diffcessible","last_synced_at":"2025-03-21T20:34:29.454Z","repository":{"id":223893577,"uuid":"757482051","full_name":"panglesd/diffcessible","owner":"panglesd","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-05T18:02:29.000Z","size":179,"stargazers_count":12,"open_issues_count":14,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-02T02:00:07.465Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/panglesd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2024-02-14T15:31:29.000Z","updated_at":"2024-03-21T08:25:33.000Z","dependencies_parsed_at":"2024-03-11T16:48:05.845Z","dependency_job_id":"5e89682e-5c60-4c6c-af1b-b8afdbe6742e","html_url":"https://github.com/panglesd/diffcessible","commit_stats":null,"previous_names":["panglesd/diffcessible"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panglesd%2Fdiffcessible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panglesd%2Fdiffcessible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panglesd%2Fdiffcessible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/panglesd%2Fdiffcessible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/panglesd","download_url":"https://codeload.github.com/panglesd/diffcessible/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221819062,"owners_count":16885884,"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-10-12T21:31:53.558Z","updated_at":"2024-10-28T10:52:16.813Z","avatar_url":"https://github.com/panglesd.png","language":"OCaml","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Diffcessible: An accessible diff viewer\n\nDiffcessible is an terminal based diff viewer with an emphasis on being accessible. Our goal is to build a diff viewer on top of Git diff that is accessible to screen readers.\n\n## Overview\n\nThe following describes the structure of the project:\n\n`bin/`: The bin directory contains the main entry point for the application and contains the implementation for the command-line interface.\n`lib/`: The lib directory contains the main logic for the diff viewer. It is responsible for parsing the diff and displaying it in the terminal.\n`test/`: The test directory contains the test suite for the project.\n`vendor/`: The vendor directory contains the vendored dependencies for the project.\n\n## Setup Dependencies\n\nTo set up the project, please fork the repository and clone it to your local machine. You will need to have `opam` installed to install the dependencies. Once you have `opam` installed, you can run the following command to install the dependencies:\n\n```bash\nopam install . --deps-only --with-test\n```\n\n## Running the Project\n\nThis project runs using the output of a git diff command. Such as:\n```bash\ngit diff \u003e git.diff\n```\n\nFor testing there is an included file `example.diff` that already contains a diff output.\n\nTo run the project, you can use the following command:\n\n```bash\ndune exec diffcessible [path/to/git.diff]\n```\n\n## Technologies Used\n\nThe following is a list of the technologies used in the project:\n\n- [**Patch Library**](https://github.com/hannesm/patch): For parsing and printing diffs.\n- **[Notty](https://github.com/pqwy/notty/) \u0026 [Lwd](https://github.com/let-def/lwd) Libraries**: For terminal layout declaration and creating a reactive UI.\n- **[Nottui Library](https://github.com/let-def/lwd/tree/master/lib/nottui)**: Integrates Lwd and Notty for UI development.\n- **[Cmdliner Library](https://github.com/dbuenzli/cmdliner)**: Facilitates command-line interface creation.\n- **[Dune Build System](https://github.com/ocaml/dune)**: For project building.\n\n## Contributing\n\nContributions are welcome! Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed instructions on how to contribute to this project.\n\n## Learning Resources\n\nFor those new to OCaml or looking to enhance their skills, here are some recommended resources:\n\n- [Real World OCaml](https://dev.realworldocaml.org/toc.html): A comprehensive guide to OCaml, covering practical examples and in-depth concepts.\n- [OCaml Programming: Correct + Efficient + Beautiful](https://www.cs.cornell.edu/courses/cs3110/2022sp/): A course that covers OCaml programming, including functional programming, data structures, and algorithms.\n- [Introduction to Functional Programming in OCaml](https://delimited-continuation.github.io/YSC1212/2022-2023_Sem2/index.html): Offers a fundamental understanding of functional programming principles using OCaml.\n- [Introduction to Data Structures and Algorithms in OCaml](https://ilyasergey.net/YSC2229/): Offers a comprehensive understanding of data structures and algorithms using OCaml.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanglesd%2Fdiffcessible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpanglesd%2Fdiffcessible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpanglesd%2Fdiffcessible/lists"}