Go to file
m455 d810724cb7 added a comment 2020-06-15 16:32:02 -04:00
src added a comment 2020-06-15 16:32:02 -04:00
LICENSE forgot to remove commented-out code 2019-09-02 10:58:04 -04:00
Makefile added a readme and a makefile 2020-06-15 14:09:05 -04:00
README.md fixed toc heading 2020-06-15 14:19:47 -04:00

README.md

nicethings

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

Table of Contents

How it works

Users collaborate by adding or removing nice messages to their own list, where the messages are combined and then displayed at random by any 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

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

Usage

town 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:
  town nicethings
  town add \"You are beautiful\"
  town ls
  town rm 2