diff options
| author | Ben Morrison <ben@gbmor.dev> | 2020-01-20 20:04:46 -0500 |
|---|---|---|
| committer | Ben Morrison <ben@gbmor.dev> | 2020-01-20 20:04:46 -0500 |
| commit | a2ca864a7891cbb87752d9c79e606cac3cd34a5e (patch) | |
| tree | a302226036c4589e844e16f49cbf4f01ea58954a | |
| parent | 288614bd7a38affc04d6ecea21a972a41c19ceb2 (diff) | |
| download | clinte-a2ca864a7891cbb87752d9c79e606cac3cd34a5e.tar.gz | |
updated readme
mentioned calling of $EDITOR with opt-level=3, changed resulting binary size mentioned in notes
| -rw-r--r-- | README.md | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/README.md b/README.md index c92943d..bdfde1f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # clinte [](https://travis-ci.com/gbmor/clinte) [](https://codecov.io/gh/gbmor/clinte) -Command-line community notice board. Post simple notes for other users to see. +Command-line community notice board. Post simple notes for other users to see. ## Features -* Username is tagged based on the executing user -* Shows the 15 most recent posts in descending order -* Able to go back and edit your own posts -* Title <= 30 chars -* Body <= 500 chars +- Username is tagged based on the executing user +- Shows the 15 most recent posts in descending order +- Able to go back and edit your own posts +- Title <= 30 chars +- Body <= 500 chars +- Calls `$EDITOR` when creating or modifying the body of a post +- If `$EDITOR` is unset, calls `nano` [](https://github.com/gbmor/clinte/blob/master/assets/clinte.png) @@ -16,8 +18,8 @@ Command-line community notice board. Post simple notes for other users to see. Current build dependencies are as follows: -* `rustc/cargo >= 1.36` -* `libsqlite3-dev` +- `rustc/cargo >= 1.36` +- `libsqlite3-dev` The installation for the build deps will vary based on your OS (`Linux, BSD`) @@ -45,6 +47,7 @@ Issuing the program name itself will list the currently available posts, like in the screenshot above. To display the 15 most recent posts: + ``` $ clinte ``` @@ -60,17 +63,21 @@ tagged automatically by your logged-in username, reflecting its intended use on multi-user UNIX-like systems. To edit a post: + ``` $ clinte update ``` + `clinte` will ask for the ID number of the post. If it's been authored by you, then you will be asked for the new title and body after being shown the previous title and body. To delete a post: + ``` $ clinte delete ``` + Then `clinte` asks for the numeric ID of the post to delete. ## Contributing @@ -82,23 +89,17 @@ to flesh it out. ## Notes `clinte` has roughly 60 library dependencies from the `rust` ecosystem. -Nevertheless, the binary remains only `3.5MB` in size as of `v0.4.1`. -For your information, the direct library dependencies of `clinte` are: -* `chrono >= 0.4` -* `clap >= 2.33` -* `lazy_static >= 1.4` -* `log >= 0.4` -* `rusqlite >= 0.20` -* `simplelog >= 0.7` -* `users >= 0.9` +Nevertheless, the binary remains only `2.1MB` in size as of `v0.4.3`. +For your information, the direct library dependencies of `clinte` are: + +- `chrono >= 0.4` +- `clap >= 2.33` +- `lazy_static >= 1.4` +- `log >= 0.4` +- `rusqlite >= 0.20` +- `simplelog >= 0.7` +- `users >= 0.9` The indirect dependencies (dependencies of dependencies) are: -`ansi_term, arrayref, arrayvec, atty, autocfg, backtrace, backtrace-sys, base64, -bitflags, blake2b_simd, byteorder, cc, cfg-if, cloudabi, constant_time_eq, -crossbeam-utils, dirs, dirs-sys, failure, failure_derive, fallible-iterator, -fallible-streaming-iterator, fuchsia-cprng, libc, libsqlite3-sys, linked-hash-map, -lru-cache, memchr, nodrop, num-integer, num-traits, pkg-config, proc-macro2, quote, -rand_core, rand_os, rdrand, redox_syscall, redox_users, rust-argon2, rustc-demangle, -strsim, syn, synstructure, term, textwrap, time, unicode-width, unicode-xid, vcpkg, -winapi, winapi-i686-pc-windows-gnu, winapi-x86_64-pc-windows-gnu` +`ansi_term, arrayref, arrayvec, atty, autocfg, backtrace, backtrace-sys, base64, bitflags, blake2b_simd, byteorder, cc, cfg-if, cloudabi, constant_time_eq, crossbeam-utils, dirs, dirs-sys, failure, failure_derive, fallible-iterator, fallible-streaming-iterator, fuchsia-cprng, libc, libsqlite3-sys, linked-hash-map, lru-cache, memchr, nodrop, num-integer, num-traits, pkg-config, proc-macro2, quote, rand_core, rand_os, rdrand, redox_syscall, redox_users, rust-argon2, rustc-demangle, strsim, syn, synstructure, term, textwrap, time, unicode-width, unicode-xid, vcpkg, winapi, winapi-i686-pc-windows-gnu, winapi-x86_64-pc-windows-gnu` |