|
2 weeks ago | |
---|---|---|
src | 6 months ago | |
LICENSE | 2 years ago | |
Makefile | 9 months ago | |
README.md | 2 weeks ago |
A program to cheer people up on shared Unix servers, specifically, tilde.town.
This is a hobby project I built for tilde.town.
I take no responsibility for anything that nicethings deletes.
Backup anything you don't want deleted.
Inline code
: Inline code signifies package names, filenames, or commandsCode block
: Code blocks signify file contentsEach 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.
~/.nicethings
directory.nicethings add "your nice message here"
interface.nicethings ls
interface.nicethings rm 2
interface, where the number refers to an item in their list.nicethings
interface (with no arguments).Below is a list of platforms that nicethings can run on:
The following items must be downloaded and installed before you can use nicethings:
This section is for users who are familiar with git, a Unix-like command line environment, or scripting.
git clone https://git.m455.casa/m455/nicethings.git
cd nicethings
sudo make install-global
nicethings
Note: To uninstall, run sudo make uninstall-global
nicethings help
- Displays the help messagenicethings add "your nice message here"
- Adds the message inside of quotation marks to your list of nice thingsnicethings ls
- Displays your list of nice thingsnicethings rm 2
- Removes the third item from your list. (The list starts at 0)Note: You may need to run nicethings ls
to see which number corresponds to which item in your list before running nicethings rm <number>
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 register for an account to download it.
You can use tools such as git
to download nicethings's source code. You
will need the source code to install nicethings.
git clone https://git.m455.casa/m455/nicethings.git
Note: This will create a nicethings
directory in your current directory.
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.
See the options below for installing nicethings:
This option will install nicethings into /usr/local/bin/
.
This section assumes you have downloaded nicethings.
cd nicethings
sudo make install-global
This option will install nicethings into ~/.local/bin/
.
This section assumes you have downloaded nicethings.
cd nicethings
make install-local
If you wish to have nicethings exist elsewhere on your system, you can also
build a single-file executable. Building a single-file executable
allows you to place the executable in convenient places on your
system, such as a directory on your $PATH
.
This section assumes you have downloaded nicethings.
Warning: You will have to manually uninstall custom installations
cd nicethings
make install-custom location=~/path/to/custom/location
Example: In step 2., you could run make install-custom location=~/bin/
Depending on your installation method, you can uninstall a global or local installation of nicethings.
See the options below for uninstalling nicethings:
This option will remove the nicethings
executable from /usr/local/bin/
.
This section assumes you have downloaded nicethings.
cd nicethings
sudo make uninstall-global
This option will remove the nicethings
executable from ~/.local/bin/
.
This section assumes you have downloaded nicethings.
cd nicethings
make uninstall-local
This section will teach you how to use nicethings's commands.
This section assumes you have installed nicethings.
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.
nicethings help
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.
Note: These numbers are useful references for when you want to remove items from your list.
nicethings ls
Adding an item to your list will save it to a text file to access later.
nicethings add "this is an example of an item using double quotation marks"
Note: The double quotation marks are optional, but recommended
When removing an item from your list, you can reference the numbers beside each item when Displaying Your List. You can use these numbers when removing an item from your list.
nicethings rm 1
Note 1: The "1" in the procedure above will remove the first item in your list.
Note 2: You may need to run nicethings ls
first to see which numbers correspond
with which item in your list.
This section lists and describes nicethings's commands.
help
displays the help messagels
displays your listadd
adds an item to your listrm
removes an item from your listThe examples below assume that you have added nicethings to your $PATH.
nicethings help
nicethings ls
nicethings add "this is a nice message"
nicethings rm 1
Note: You may have to run nicethings ls
to see which number corresponds to which item in your list.