~gbmor/clinte

ref: f3c780970b05a1e78152920d4dfc5e154e82e212 clinte/README.md -rw-r--r-- 1.8 KiB
f3c78097 — Ben Morrison updated usage 2 years ago

#clinte   Build Status codecov

Command-line community notice board. Post simple notes for other users to see.

#Features

  • Username is tagged based on the executing user
  • Shows the 30 most recent posts in descending order
  • Able to go back and edit your own posts
  • Title <= 30 chars
  • Body <= 500 chars

Screenshot

#Installation

Current build dependencies are as follows:

  • rustc/cargo >= 1.36
  • libsqlite3-dev

The installation for the build deps will vary based on your OS (Linux, BSD)

Clone the repository and jump into the directory:

$ git clone git://github.com/gbmor/clinte.git
...
$ cd clinte

Run the makefile and install:

$ make
...
...Done!

$ sudo make install

#Usage

Issuing the program name itself will list the currently available posts, like in the screenshot above.

To make a new post:

$ clinte post

clinte will then ask for the title of the post, and the body. The username will be 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.

#Contributing

This is very new, so feel free to hack on it in any way you please and submit a PR! I'll be working on it myself over the next several days to flesh it out.