Go to file

m455 cb5eb0e093 updated wording		2020-07-07 11:26:23 -04:00
src	Changed an example to a more realistic example	2020-06-21 12:12:22 -04:00
LICENSE	forgot to remove commented-out code	2019-09-02 10:58:04 -04:00
Makefile	updated custom installation	2020-07-07 11:25:35 -04:00
README.md	updated wording	2020-07-07 11:26:23 -04:00

README.md

nicethings

A program for shared Unix servers, specifically tilde.town, to cheer people up .

How it works
- How it works in detail
Installation
Usage

How it works

Each user on the shared Unix server may have a .nicethings file. The .nicethings file may be populated with a list of nice messages created by a user. All users' .nicethings files are converted to lists. All lists are combined into one list. A random nice message is picked from from this list and is displayed to the user.

How it works in detail

Each user has a ~/.nicethings directory.
Users can add messages to this file using the nicethings add "your nice message here" interface.
Each message is stored in the file as separate lines. No file format is used.
Users can display a numbered list of the messages they have stored using the nicethings ls interface.
Users can remove their own messages using the nicethings rm 2 interface, where the number refers to an item in their list.
Users can view a random message from a random user using the nicethings interface (with no arguments).

Installation

Run git clone https://github.com/m455/nicethings
Run cd nicethings
Run make for further installation instructions.

Usage

nicethings [<command>] [<args>]

Commands:
  No command - Print a random nice thing.
  add        - Add a message to the list of nice things.
  ls         - Print a numbered list of the nice things you have added.
  rm         - Remove a message you have added from the list of nice things.

Examples:
  nicethings
  nicethings add \"You are beautiful\"
  nicethings ls
  nicethings rm 2