Rust quick notes app

TODO: Name

Description

TODO

Installing

For now, you have to compile the program yourself. Make sure you have rust compiler and cargo.

git clone {REPO_ADDRESS_HERE}
cd rust-notes
cargo build
./target/release/rust_notes

Usage

Current development version:

• For now, Enter: read file in buffer and e: edits file in vim
• The software saves files in .txt format in /home/USER/Notes/ folder, application will create the folder if it doesnt exists.

Breaking changes are most likely to come, this is in very early development.

Features TODO:

Check codeberg issues https://codeberg.org/Katacc/rust-notes/issues

Development environment

The premade development environment is using Flox. https://flox.dev/download/

flox activate

Developing

Start with using ratatui rust crate for TUI interface https://ratatui.rs/

All files apart from main is imported in lib.rs. There is no real reason why this way, I just like to separate the "package declaration" separately from main.

Contributing

Note

As of now, I don't accept contributions to major parts of the program, I started this as a learning project, so I will make the parts that I was actually gonna learn myself first. Im reserving issues that are assigned to myself!

Contributing is welcome, please first open a issue or comment on a issue on a feature you are working on.
All code in the codebase are to be written without object oriented methodology.

Writing documentation is also a good way to help :)

Licensing

MIT license, see LICENSE