Documentation with internal links

chipsenkbeil / vimwiki-rs

Rust library and tooling to parse, render, and modify vimwiki text and files.

56 stars 2 forks source link

Documentation with internal links #106

Closed tinmarino closed 3 years ago

tinmarino commented 3 years ago

Hi Chip,

Small PR just to modify main README.md and remove Cargo.lock from git. I would be nice to have a quickstart for users who do not care about the rust implementation but want to use the command line tool.

Cheers, Tin.

chipsenkbeil commented 3 years ago

@tinmarino, unsure about the Cargo.lock. I've got both libraries and binaries and there's a recommendation to keep the lock file for binaries and ignore it for libraries 😆 (https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html). Looks like I also have Cargo.lock files within my individual workspace member directories, so not sure which ones are relevant.

Merge for now, but may change the README again later. XD