Updated readme section order
m455
parent
7ca3821950
commit
a951d89980
97
README.md
97
README.md
|
|
@ -4,54 +4,43 @@ A program for shared Unix servers, specifically [tilde.town](https://tilde.town)
|
||||||
|
|
||||||
# Table of Contents
|
# Table of Contents
|
||||||
|
|
||||||
- [How it works](#how-it-works)
|
<!-- vim-markdown-toc GFM -->
|
||||||
- [How it works in detail](#how-it-works-in-detail)
|
|
||||||
- [Disclaimer](#disclaimer)
|
|
||||||
- [Conventions used in this document](#conventions-used-in-this-document)
|
|
||||||
- [Requirements](#requirements)
|
|
||||||
- [Quick start](#quick-start)
|
|
||||||
- [Downloading nicethings](#downloading-nicethings)
|
|
||||||
- [Downloading nicethings using git](#downloading-nicethings-using-git)
|
|
||||||
- [To download nicethings using git](#to-download-nicethings-using-git)
|
|
||||||
- [Installing nicethings](#installing-nicethings)
|
|
||||||
- [Installing nicethings globally](#installing-nicethings-globally)
|
|
||||||
- [To install nicethings globally](#to-install-nicethings-globally)
|
|
||||||
- [Installing nicethings locally](#installing-nicethings-locally)
|
|
||||||
- [To install nicethings locally](#to-install-nicethings-locally)
|
|
||||||
- [Installing nicethings to a custom directory](#installing-nicethings-to-a-custom-directory)
|
|
||||||
- [To install nicethings to a custom directory](#to-install-nicethings-to-a-custom-directory)
|
|
||||||
- [Uninstalling nicethings](#uninstalling-nicethings)
|
|
||||||
- [Uninstalling nicethings globally](#uninstalling-nicethings-globally)
|
|
||||||
- [To uninstall nicethings globally](#to-uninstall-nicethings-globally)
|
|
||||||
- [Uninstalling nicethings locally](#uninstalling-nicethings-locally)
|
|
||||||
- [To uninstall nicethings locally](#to-uninstall-nicethings-locally)
|
|
||||||
- [Using nicethings](#using-nicethings)
|
|
||||||
- [Showing the help message](#showing-the-help-message)
|
|
||||||
- [To show the help message](#to-show-the-help-message)
|
|
||||||
- [Displaying your list](#displaying-your-list)
|
|
||||||
- [To display your list](#to-display-your-list)
|
|
||||||
- [Adding an item to your list](#adding-an-item-to-your-list)
|
|
||||||
- [To add an item to your list](#to-add-an-item-to-your-list)
|
|
||||||
- [Removing an item from your list](#removing-an-item-from-your-list)
|
|
||||||
- [To remove an item from your list](#to-remove-an-item-from-your-list)
|
|
||||||
- [List of commands](#list-of-commands)
|
|
||||||
- [Usage examples](#usage-examples)
|
|
||||||
|
|
||||||
# How it works
|
* [Disclaimer](#disclaimer)
|
||||||
|
* [Conventions used in this document](#conventions-used-in-this-document)
|
||||||
|
* [How it works](#how-it-works)
|
||||||
|
* [How it works in detail](#how-it-works-in-detail)
|
||||||
|
* [Platforms](#platforms)
|
||||||
|
* [Requirements](#requirements)
|
||||||
|
* [Quick start](#quick-start)
|
||||||
|
* [Downloading nicethings](#downloading-nicethings)
|
||||||
|
* [Downloading nicethings using git](#downloading-nicethings-using-git)
|
||||||
|
* [To download nicethings using git](#to-download-nicethings-using-git)
|
||||||
|
* [Installing nicethings](#installing-nicethings)
|
||||||
|
* [Installing nicethings globally](#installing-nicethings-globally)
|
||||||
|
* [To install nicethings globally](#to-install-nicethings-globally)
|
||||||
|
* [Installing nicethings locally](#installing-nicethings-locally)
|
||||||
|
* [To install nicethings locally](#to-install-nicethings-locally)
|
||||||
|
* [Installing nicethings to a custom directory](#installing-nicethings-to-a-custom-directory)
|
||||||
|
* [To install nicethings to a custom directory](#to-install-nicethings-to-a-custom-directory)
|
||||||
|
* [Uninstalling nicethings](#uninstalling-nicethings)
|
||||||
|
* [Uninstalling nicethings globally](#uninstalling-nicethings-globally)
|
||||||
|
* [To uninstall nicethings globally](#to-uninstall-nicethings-globally)
|
||||||
|
* [Uninstalling nicethings locally](#uninstalling-nicethings-locally)
|
||||||
|
* [To uninstall nicethings locally](#to-uninstall-nicethings-locally)
|
||||||
|
* [Using nicethings](#using-nicethings)
|
||||||
|
* [Showing the help message](#showing-the-help-message)
|
||||||
|
* [To show the help message](#to-show-the-help-message)
|
||||||
|
* [Displaying your list](#displaying-your-list)
|
||||||
|
* [To display your list](#to-display-your-list)
|
||||||
|
* [Adding an item to your list](#adding-an-item-to-your-list)
|
||||||
|
* [To add an item to your list](#to-add-an-item-to-your-list)
|
||||||
|
* [Removing an item from your list](#removing-an-item-from-your-list)
|
||||||
|
* [To remove an item from your list](#to-remove-an-item-from-your-list)
|
||||||
|
* [List of commands](#list-of-commands)
|
||||||
|
* [Usage examples](#usage-examples)
|
||||||
|
|
||||||
Each user on the shared Unix server may have a `.nicethings` file. The `.nicethings` file may be
|
<!-- vim-markdown-toc -->
|
||||||
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).
|
|
||||||
|
|
||||||
# Disclaimer
|
# Disclaimer
|
||||||
|
|
||||||
|
|
@ -70,6 +59,22 @@ Backup anything you don't want deleted.
|
||||||
* `Inline code`: Inline code signifies package names, filenames, or commands
|
* `Inline code`: Inline code signifies package names, filenames, or commands
|
||||||
* ```Code block```: Code blocks signify file contents
|
* ```Code block```: Code blocks signify file contents
|
||||||
|
|
||||||
|
# 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).
|
||||||
|
|
||||||
# Platforms
|
# Platforms
|
||||||
|
|
||||||
Below is a list of platforms that nicethings can run on:
|
Below is a list of platforms that nicethings can run on:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue