tildetown
/
nicethings
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme hierarchy

cleanup
m455 2021-02-24 19:18:47 -05:00
parent 7f37ce3347
commit ce7f777329
1 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -2,7 +2,7 @@
A program for shared Unix servers, specifically [tilde.town](https://tilde.town), to cheer people up. A program for shared Unix servers, specifically [tilde.town](https://tilde.town), to cheer people up.
# Table of Contents ## Table of Contents
<!-- vim-markdown-toc GFM --> <!-- vim-markdown-toc GFM -->
@ -42,7 +42,7 @@ A program for shared Unix servers, specifically [tilde.town](https://tilde.town)
<!-- vim-markdown-toc --> <!-- vim-markdown-toc -->
# Disclaimer ## Disclaimer
This is a hobby project I built for [tilde.town](tilde.town). This is a hobby project I built for [tilde.town](tilde.town).
@ -50,7 +50,7 @@ I take no responsibility for anything that nicethings deletes.
Backup anything you don't want deleted. Backup anything you don't want deleted.
# Conventions used in this document ## Conventions used in this document
* **Note**: Notes signify additional information * **Note**: Notes signify additional information
* **Tip**: Tips signify an alternate procedure for completing a step * **Tip**: Tips signify an alternate procedure for completing a step
@ -59,14 +59,14 @@ 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 ## How it works
Each user on the shared Unix server may have a `.nicethings` file. The `.nicethings` file may be 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 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 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. this list and is displayed to the user.
## How it works in detail ### How it works in detail
* Each user has a `~/.nicethings` directory. * Each user has a `~/.nicethings` directory.
* Users can add messages to this file using the `nicethings add "your nice message here"` interface. * Users can add messages to this file using the `nicethings add "your nice message here"` interface.
@ -75,7 +75,7 @@ this list and is displayed to the user.
* Users can remove their own messages using the `nicethings rm 2` interface, where the number refers to an item in their list. * 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). * 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:
@ -83,13 +83,13 @@ Below is a list of platforms that nicethings can run on:
* Windows (Using Windows Subsystem for Linux) * Windows (Using Windows Subsystem for Linux)
* macOS (Using [Homebrew](https://brew.sh/)) * macOS (Using [Homebrew](https://brew.sh/))
# Requirements ## Requirements
The following items must be downloaded and installed before you can use nicethings: The following items must be downloaded and installed before you can use nicethings:
* Racket: [https://racket-lang.org/](https://racket-lang.org/) * Racket: [https://racket-lang.org/](https://racket-lang.org/)
# Quick start ## Quick start
This section is for users who are familiar with git, a Unix-like command line environment, or This section is for users who are familiar with git, a Unix-like command line environment, or
scripting. scripting.
@ -109,24 +109,24 @@ scripting.
**Note**: You may need to run `nicethings ls` to see which number corresponds to which item in your list before running `nicethings rm <number>` **Note**: You may need to run `nicethings ls` to see which number corresponds to which item in your list before running `nicethings rm <number>`
# Downloading nicethings ## Downloading nicethings
nicethings's source code exists in a public git repository. This makes nicethings's source code exists in a public git repository. This makes
accessing the code convenient, because you don't need to sign in or accessing the code convenient, because you don't need to sign in or
register for an account to download it. register for an account to download it.
## Downloading nicethings using git ### Downloading nicethings using git
You can use tools such as `git` to download nicethings's source code. You You can use tools such as `git` to download nicethings's source code. You
will need the source code to install nicethings. will need the source code to install nicethings.
### To download nicethings using git #### To download nicethings using git
1. Run `git clone https://git.m455.casa/m455/nicethings.git` 1. Run `git clone https://git.m455.casa/m455/nicethings.git`
**Note**: This will create a `nicethings` directory in your current directory. **Note**: This will create a `nicethings` directory in your current directory.
# Installing nicethings ## Installing nicethings
You can either install nicethings globally or locally on your system. A global installation allows all users on a machine to use nicethings, while a local installation only allows one user to use nicethings. You can either install nicethings globally or locally on your system. A global installation allows all users on a machine to use nicethings, while a local installation only allows one user to use nicethings.
@ -136,29 +136,29 @@ See the options below for installing nicethings:
* [Installing nicethings locally](#installing-nicethings-locally) * [Installing nicethings locally](#installing-nicethings-locally)
* [Installing nicethings to a custom directory](#installing-nicethings-to-a-custom-directory) * [Installing nicethings to a custom directory](#installing-nicethings-to-a-custom-directory)
## Installing nicethings globally ### Installing nicethings globally
This option will install nicethings into `/usr/local/bin/`. This option will install nicethings into `/usr/local/bin/`.
This section assumes you have [downloaded nicethings](#downloading-nicethings). This section assumes you have [downloaded nicethings](#downloading-nicethings).
### To install nicethings globally #### To install nicethings globally
1. Run `cd nicethings` 1. Run `cd nicethings`
2. Run `sudo make install-global` 2. Run `sudo make install-global`
## Installing nicethings locally ### Installing nicethings locally
This option will install nicethings into `~/.local/bin/`. This option will install nicethings into `~/.local/bin/`.
This section assumes you have [downloaded nicethings](#downloading-nicethings). This section assumes you have [downloaded nicethings](#downloading-nicethings).
### To install nicethings locally #### To install nicethings locally
1. Run `cd nicethings` 1. Run `cd nicethings`
2. Run `sudo make install-local` 2. Run `sudo make install-local`
## Installing nicethings to a custom directory ### Installing nicethings to a custom directory
If you wish to have nicethings exist elsewhere on your system, you can also If you wish to have nicethings exist elsewhere on your system, you can also
build a single-file executable. Building a single-file executable build a single-file executable. Building a single-file executable
@ -167,7 +167,7 @@ system, such as a directory on your `$PATH`.
This section assumes you have [downloaded nicethings](#downloading-nicethings). This section assumes you have [downloaded nicethings](#downloading-nicethings).
### To install nicethings to a custom directory #### To install nicethings to a custom directory
**Warning**: You will have to manually uninstall custom installations **Warning**: You will have to manually uninstall custom installations
@ -176,7 +176,7 @@ This section assumes you have [downloaded nicethings](#downloading-nicethings).
**Example**: In step 2., you could run `make install-custom location=~/bin/` **Example**: In step 2., you could run `make install-custom location=~/bin/`
# Uninstalling nicethings ## Uninstalling nicethings
Depending on your installation method, you can uninstall a global or local installation of nicethings. Depending on your installation method, you can uninstall a global or local installation of nicethings.
@ -185,44 +185,44 @@ See the options below for uninstalling nicethings:
* [Uninstalling nicethings globally](#uninstalling-nicethings-globally) * [Uninstalling nicethings globally](#uninstalling-nicethings-globally)
* [Uninstalling nicethings locally](#uninstalling-nicethings-locally) * [Uninstalling nicethings locally](#uninstalling-nicethings-locally)
## Uninstalling nicethings globally ### Uninstalling nicethings globally
This option will remove the `nicethings` executable from `/usr/local/bin/`. This option will remove the `nicethings` executable from `/usr/local/bin/`.
This section assumes you have [downloaded nicethings](#downloading-nicethings). This section assumes you have [downloaded nicethings](#downloading-nicethings).
### To uninstall nicethings globally #### To uninstall nicethings globally
1. Run `cd nicethings` 1. Run `cd nicethings`
2. Run `sudo make uninstall-global` 2. Run `sudo make uninstall-global`
## Uninstalling nicethings locally ### Uninstalling nicethings locally
This option will remove the `nicethings` executable from `~/.local/bin/`. This option will remove the `nicethings` executable from `~/.local/bin/`.
This section assumes you have [downloaded nicethings](#downloading-nicethings). This section assumes you have [downloaded nicethings](#downloading-nicethings).
### To uninstall nicethings locally #### To uninstall nicethings locally
1. Run `cd nicethings` 1. Run `cd nicethings`
2. Run `sudo make uninstall-local` 2. Run `sudo make uninstall-local`
# Using nicethings ## Using nicethings
This section will teach you how to use nicethings's commands. This section will teach you how to use nicethings's commands.
This section assumes you have [installed nicethings](#installing-nicethings). This section assumes you have [installed nicethings](#installing-nicethings).
## Showing the help message ### Showing the help message
The help message will provide a list of available commands. This is list useful in case you forget The help message will provide a list of available commands. This is list useful in case you forget
the name of a command or how to use a command. the name of a command or how to use a command.
### To show the help message #### To show the help message
1. Run `nicethings help` 1. Run `nicethings help`
## Displaying your list ### Displaying your list
Displaying your list will allow you to view items you have added to your list. Displaying your list will allow you to view items you have added to your list.
You will notice numbers beside the items in your list. You will notice numbers beside the items in your list.
@ -230,27 +230,27 @@ You will notice numbers beside the items in your list.
**Note**: These numbers are useful references for when you want to **Note**: These numbers are useful references for when you want to
[remove items from your list](#removing-an-item-from-your-list). [remove items from your list](#removing-an-item-from-your-list).
### To display your list #### To display your list
1. Run `nicethings ls` 1. Run `nicethings ls`
## Adding an item to your list ### Adding an item to your list
Adding an item to your list will save it to a text file to access later. Adding an item to your list will save it to a text file to access later.
### To add an item to your list #### To add an item to your list
1. Run `nicethings add "this is an example of an item using double quotation marks"` 1. Run `nicethings add "this is an example of an item using double quotation marks"`
**Note**: The double quotation marks are optional, but recommended **Note**: The double quotation marks are optional, but recommended
## Removing an item from your list ### Removing an item from your list
When removing an item from your list, you can reference the numbers beside each When removing an item from your list, you can reference the numbers beside each
item when [Displaying Your List](#displaying-your-list). You can use these item when [Displaying Your List](#displaying-your-list). You can use these
numbers when removing an item from your list. numbers when removing an item from your list.
### To remove an item from your list #### To remove an item from your list
1. Run `nicethings rm 1` 1. Run `nicethings rm 1`
@ -260,7 +260,7 @@ list.
**Note 2**: You may need to run `nicethings ls` first to see which numbers correspond **Note 2**: You may need to run `nicethings ls` first to see which numbers correspond
with which item in your list. with which item in your list.
# List of commands ## List of commands
This section lists and describes nicethings's commands. This section lists and describes nicethings's commands.
@ -269,7 +269,7 @@ This section lists and describes nicethings's commands.
* `add` adds an item to your list * `add` adds an item to your list
* `rm` removes an item from your list * `rm` removes an item from your list
# Usage examples ## Usage examples
The examples below assume that you have [added nicethings to your $PATH](#adding-nicethings-to-your-path). The examples below assume that you have [added nicethings to your $PATH](#adding-nicethings-to-your-path).