rodo/README.md

# rodo

rodo is a todo-list program for the command line.

Todo:

- [X] Learn the basics of Makefiles
- [X] Make a Makefile
- [ ] Update the `README.md` to match the new `Makefile`
- [ ] Remove `install.sh` and `uninstall.sh` scripts after the `README.md` is updated

# Screenshot

![](screenshot.gif)

# Table of Contents

- [About this document](#about-this-document)
- [Conventions used in this document](#conventions-used-in-this-document)
- [Platforms](#platforms)
- [Requirements](#requirements)
    - [Downloading Racket](#downloading-racket)
        - [To download and install Racket](#to-download-and-install-racket)
    - [Downloading the rodo source code](#downloading-the-rodo-source-code)
        - [To download the rodo source code](#to-download-the-rodo-source-code)
- [Quick start](#quick-start)
- [Getting started](#getting-started)
    - [Installing rodo](#installing-rodo)
        - [To install rodo](#to-install-rodo)
    - [Uninstalling rodo](#uninstalling-rodo)
        - [To uninstall rodo](#to-uninstall-rodo)
- [Using rodo](#using-rodo)
    - [Showing the help message](#showing-the-help-message)
        - [To show the help message](#to-show-the-help-message)
    - [Initializing rodo](#initializing-rodo)
        - [To initialize rodo](#to-initialize-rodo)
    - [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)
    - [Configuring rodo](#configuring-rodo)
        - [To configure rodo](#to-configure-rodo)
- [List of commands](#list-of-commands)
- [Usage examples](#usage-examples)

# About this document

This document will guide you through downloading, installing, and using rodo.

This document assumes you have basic command line skills, such as navigating
directories, and editing files.

# Conventions used in this document

* **Note**: Notes signify additional information
* **Tip**: Tips signify an alternate procedure for completing a step
* **Caution**: Cautions signify that damage may occur
* **Example**: Examples provide a visual reference of how a procedure would be carried out in the real world
* `Inline code`: Inline code signifies package names, filenames, or commands
* ```Code block```: Code blocks signify file contents

# Platforms

Below is a list of platforms that rodo can run on:

* GNU/Linux
* Windows Subsystem for Linux
* macOS (Untested)

# Requirements

The following items must be downloaded and installed before you can use rodo:

* Racket: [https://racket-lang.org/](https://racket-lang.org/)
* rodo's source code: [https://github.com/m455/rodo](https://github.com/m455/rodo)

## Downloading Racket

The Racket programming language will be needed to create a single-file executable

### To download and install Racket

1. Run `sudo apt install racket` on the command line

## Downloading the rodo source code

rodo's source code is needed so Racket's `raco` tool can create a single-file executable

### To download the rodo source code

1. Run `git clone https://github.com/m455/rodo`

# Quick start

This section is for users who are familiar with git, a Unix-like command line environment, or
scripting.

1. Make sure [Racket](https://racket-lang.org/) is installed
2. `git clone https://github.com/m455/rodo`
3. `cd rodo`
4. `sudo ./install.sh`
5. `rodo`

**Note**: To uninstall, run `sudo ./uninstall.sh`

# Getting started

This section will guide you through settig up rodo.

**Note**: This section assumes you have already [downloaded the rodo source code](#downloading-the-rodo-source-code).

## Installing rodo

Installing rodo will add a rodo executable to the `/usr/local/bin` directory. This allows users to
run rodo from any directory on their system.

**Note**: Writing to the `/usr/local/bin` directory requires root privileges.

### To install rodo

1. Change to the directory you downloaded rodo into
2. Run `sudo ./install.sh`

## Uninstalling rodo

Uninstalling rodo removes the rodo executable from the `/usr/local/bin` directory.

### To uninstall rodo

1. Change to the directory you downloaded rodo into
2. Run `sudo ./uninstall`

# Using rodo

This section will teach you how to use rodo's commands.

**Note**: This section assumes you have [installed rodo](#installing-rodo).

## Showing the help message

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.

### To show the help message

1. Run `rodo -h`

## Initializing rodo

Before using rodo, you must initialize rodo. Initializing will allow you to save
your list to a text file for later access.

### To initialize rodo

1. Run `rodo init`

## Displaying 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.

**Note**: These numbers are useful references for when you want to remove items from your list. For
more information, see the [Removing an Item from Your List](#removing-an-item-from-your-list) topic.

### To display your list

1. Run `rodo ls`

## Adding an item to your list

Adding an item to your list will save it to a text file to access later.

### To add an item to your list

1. Run `rodo add "this is an example of an item using double quotation marks"`

**Note**: The double quotation marks are optional, but recommended

## Removing an item from your list

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
numbers when removing an item from your list.

### To remove an item from your list

1. Run `rodo 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 `rodo ls` first to see which numbers correspond
with which item in your list.

## Configuring rodo

You can configure rodo's settings, such as the location of the list file, and
command names.

### To configure rodo

**Caution**: Changing the `config.rkt` file should be done at your own risk as it may break rodo's functionality

1. Edit the `config.rkt` file
2. `sudo ./install.sh`

# List of commands

This section lists and describes rodo's commands.

* `-h` or `--help` displays the help message
* `init` creates a list file (See the `config.rkt` file for the default location of this file)
* `ls` displays your list
* `add` adds an item to your list
* `rm` removes an item from your list

# Usage examples

The examples below assume that you have [added rodo to your $PATH](#adding-rodo-to-your-path).

`rodo -h`

`rodo --help`

`rodo init`

`rodo ls`

`rodo add "this is an item"`

`rodo add this is an item without quotation marks`

`rodo rm 1`

**Note**: You may have to run `rodo ls` to see which number corresponds to which item in your list.