{"id":19163055,"url":"https://github.com/federicobruzzone/caml-writer","last_synced_at":"2026-02-07T06:03:41.506Z","repository":{"id":189761694,"uuid":"681227308","full_name":"FedericoBruzzone/caml-writer","owner":"FedericoBruzzone","description":"CamlWriter is a terminal-based text editor developed using the OCaML.","archived":false,"fork":false,"pushed_at":"2024-08-12T16:08:31.000Z","size":112,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T11:39:40.684Z","etag":null,"topics":["functional-programming","ocaml","terminal-based","text-editor"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FedericoBruzzone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-21T14:47:30.000Z","updated_at":"2024-09-07T12:26:21.000Z","dependencies_parsed_at":"2023-08-21T17:26:38.873Z","dependency_job_id":"2b42bb07-0265-469a-8f60-21b7272acff3","html_url":"https://github.com/FedericoBruzzone/caml-writer","commit_stats":{"total_commits":70,"total_committers":2,"mean_commits":35.0,"dds":0.02857142857142858,"last_synced_commit":"f77472d42f0a609a59bc06f24da8c984d85e1188"},"previous_names":["federicobruzzone/caml-writer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/FedericoBruzzone/caml-writer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FedericoBruzzone%2Fcaml-writer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FedericoBruzzone%2Fcaml-writer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FedericoBruzzone%2Fcaml-writer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FedericoBruzzone%2Fcaml-writer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FedericoBruzzone","download_url":"https://codeload.github.com/FedericoBruzzone/caml-writer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FedericoBruzzone%2Fcaml-writer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29187975,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T05:07:31.176Z","status":"ssl_error","status_checked_at":"2026-02-07T05:06:15.227Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["functional-programming","ocaml","terminal-based","text-editor"],"created_at":"2024-11-09T09:14:01.574Z","updated_at":"2026-02-07T06:03:41.469Z","avatar_url":"https://github.com/FedericoBruzzone.png","language":"OCaml","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CamlWriter (CW)\n\nThe **CamlWriter** project is a terminal-based text editor that has been developed using the OCaml programming language.\n\nKey features of the CamlWriter:\n\n1. _No dependencies_: CamlWriter was created without using external dependencies.\n\n2. _Terminal Setup_: CamlWriter processes byte by byte having set the terminal to `raw mode` ([more info](https://en.wikipedia.org/wiki/POSIX_terminal_interface)).\n\n3. _Terminal Interface_: CamlWriter is designed to be used entirely within a terminal environment, making it suitable for users who prefer working with text editors from the command line.\n\n4. _Basic Text Editing_: Users can create, open, edit, and save plain text files using standard text editing commands.\n\n## Project Structure\n\nThe project structure is organized as follows:\n\n```\n.\n├── bin\n│   ├── dune\n│   ├── main.ml\n│   └── ...\n├── dune-project\n├── lib\n│   └── dune\n├── caml_writer.opam\n└── test\n    ├── dune\n    └── caml_writer.ml```\n```\n\n- `./bin/main.ml`: This file contain the entry point of **CamlWriter**.\n\n- `./bin/`: This folder is intended for executable code.\n\n- `./lib/`: This folder is intended for the libraries of **CamlWriter**.\n\n- `./test/`: This folder is intended for test-related code.\n\n## Setup ocaml\n\n1. **Install opam:** It's easy to install opam with your system's package manager on Linux:\n   ```bash\n   # Ubuntu and Debian:\n   $ apt install opam\n\n   # Archlinux\n   $ pacman -S opam\n   ```\n\n2. **Initialize opam** and **Create an opam switch**:\n    ```bash\n    $ opam init          # Can take some time\n    $ eval $(opam env)\n    ```\n    ```\n    $ opam switch create 4.14.0\n    $ eval $(opam env)\n    ```\n\n3. **OCaml Platform Tools on Unix**: All these tools can be installed in your current switch:\n    ```bash\n    $ opam install dune merlin ocaml-lsp-server odoc ocamlformat utop dune-release\n    ```\n\n## Getting Started\n\n1. **Clone the Repository:** Clone this repository to your local machine using the following command:\n\n   ```\n   https://github.com/FedericoBruzzone/caml-writer.git\n   ```\n\n2. **Compile and Run:**\n\n    - `make` commands:\n      ```bash\n      $ make clean\n      $ make build\n      $ make doc\n      $ make run ARGS=[\u003cfile-path\u003e]\n      ```\n\n      or simply,\n\n      ```bash\n      $ make ARGS=[\u003cfile-path\u003e] # It will run sequentially the previous commands\n      ```\n\n    - `dune` commands:\n        ```bash\n        $ dune clean\n        $ dune build\n        $ dune build @doc\n        $ dune exec caml_writer [\u003cfile-path\u003e]\n        ```\n\n## Contributing\n\nContributions to this project are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request.\n\n## License\n\nThis repository is licensed under the [GNU General Public License (GPL)](https://www.gnu.org/licenses/gpl-3.0.html). Please review the license file provided in the repository for more information regarding the terms and conditions of the GPL license.\n\n## Useful links and commands:\n\n- [POSIX Terminal Interface](https://en.wikipedia.org/wiki/POSIX_terminal_interface)\n\n- [AsciiTable](https://www.asciitable.com/)\n\n- [Flow Control](https://en.wikipedia.org/wiki/Software_flow_control)\n\n- [VT100 docs](https://vt100.net/docs/vt100-ug/contents.html)\n\n- `showkey -a` show key information\n\n- `ocamlfind list`\n\n- `opam list`\n\n## Ispired by:\n\n- [kilo](https://viewsourcecode.org/snaptoken/kilo/)\n\n- [hecto](https://www.flenker.blog/hecto/)\n\n- [nano](https://www.nano-editor.org/)\n\n## Contact\n\nIf you have any questions, suggestions, or feedback, do not hesitate to [contact me](https://federicobruzzone.github.io/).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedericobruzzone%2Fcaml-writer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffedericobruzzone%2Fcaml-writer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffedericobruzzone%2Fcaml-writer/lists"}