Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/federicobruzzone/caml-writer
CamlWriter is a terminal-based text editor developed using the OCaML.
https://github.com/federicobruzzone/caml-writer
functional-programming ocaml terminal-based text-editor
Last synced: 7 days ago
JSON representation
CamlWriter is a terminal-based text editor developed using the OCaML.
- Host: GitHub
- URL: https://github.com/federicobruzzone/caml-writer
- Owner: FedericoBruzzone
- License: agpl-3.0
- Created: 2023-08-21T14:47:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-12T16:08:31.000Z (3 months ago)
- Last Synced: 2024-08-13T18:41:56.766Z (3 months ago)
- Topics: functional-programming, ocaml, terminal-based, text-editor
- Language: OCaml
- Homepage:
- Size: 109 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CamlWriter (CW)
The **CamlWriter** project is a terminal-based text editor that has been developed using the OCaml programming language.
Key features of the CamlWriter:
1. _No dependencies_: CamlWriter was created without using external dependencies.
2. _Terminal Setup_: CamlWriter processes byte by byte having set the terminal to `raw mode` ([more info](https://en.wikipedia.org/wiki/POSIX_terminal_interface)).
3. _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.
4. _Basic Text Editing_: Users can create, open, edit, and save plain text files using standard text editing commands.
## Project Structure
The project structure is organized as follows:
```
.
├── bin
│ ├── dune
│ ├── main.ml
│ └── ...
├── dune-project
├── lib
│ └── dune
├── caml_writer.opam
└── test
├── dune
└── caml_writer.ml```
```
- `./bin/main.ml`: This file contain the entry point of **CamlWriter**.
- `./bin/`: This folder is intended for executable code.
- `./lib/`: This folder is intended for the libraries of **CamlWriter**.
- `./test/`: This folder is intended for test-related code.
## Setup ocaml
1. **Install opam:** It's easy to install opam with your system's package manager on Linux:
```bash
# Ubuntu and Debian:
$ apt install opam
# Archlinux
$ pacman -S opam
```
2. **Initialize opam** and **Create an opam switch**:
```bash
$ opam init # Can take some time
$ eval $(opam env)
```
```
$ opam switch create 4.14.0
$ eval $(opam env)
```
3. **OCaml Platform Tools on Unix**: All these tools can be installed in your current switch:
```bash
$ opam install dune merlin ocaml-lsp-server odoc ocamlformat utop dune-release
```
## Getting Started
1. **Clone the Repository:** Clone this repository to your local machine using the following command:
```
https://github.com/FedericoBruzzone/caml-writer.git
```
2. **Compile and Run:**
- `make` commands:
```bash
$ make clean
$ make build
$ make doc
$ make run ARGS=[]
```
or simply,
```bash
$ make ARGS=[] # It will run sequentially the previous commands
```
- `dune` commands:
```bash
$ dune clean
$ dune build
$ dune build @doc
$ dune exec caml_writer []
```
## Contributing
Contributions to this project are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request.
## License
This 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.
## Useful links and commands:
- [POSIX Terminal Interface](https://en.wikipedia.org/wiki/POSIX_terminal_interface)
- [AsciiTable](https://www.asciitable.com/)
- [Flow Control](https://en.wikipedia.org/wiki/Software_flow_control)
- [VT100 docs](https://vt100.net/docs/vt100-ug/contents.html)
- `showkey -a` show key information
- `ocamlfind list`
- `opam list`
## Ispired by:
- [kilo](https://viewsourcecode.org/snaptoken/kilo/)
- [hecto](https://www.flenker.blog/hecto/)
- [nano](https://www.nano-editor.org/)
## Contact
If you have any questions, suggestions, or feedback, do not hesitate to [contact me](https://federicobruzzone.github.io/).