updated readme hierarchy

2021-02-24 19:21:16 -05:00 · 2021-02-24 19:21:16 -05:00 · fb17dc6c15
parent 4bdbdbdd32
commit fb17dc6c15
1 changed files with 35 additions and 35 deletions
--- a/README.md
+++ b/README.md
@ -2,11 +2,11 @@

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

-# Screenshot
+## Screenshot

 ![A screenshot of a user adding an removing items from their todo list in a terminal](images/screenshot.gif)

-# Table of Contents
+## Table of Contents

 - [Disclaimer](#disclaimer)
 - [Conventions used in this document](#conventions-used-in-this-document)
@ -42,7 +42,7 @@ rodo is a todo-list program for the command line.
 - [List of commands](#list-of-commands)
 - [Usage examples](#usage-examples)

-# Disclaimer
+## Disclaimer

 This is a hobby project I built for myself to keep track of todos
 related to my hobbies.
@ -51,7 +51,7 @@ I take no responsibility for anything that rodo deletes.

 Backup anything you don't want deleted.

-# Conventions used in this document
+## Conventions used in this document

 * **Note**: Notes signify additional information
 * **Tip**: Tips signify an alternative procedure for completing a step
@ -60,7 +60,7 @@ Backup anything you don't want deleted.
 * `Inline code`: Inline code signifies package names, filenames, or commands
 * ```Code block```: Code blocks signify file contents

-# Platforms
+## Platforms

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

@ -68,14 +68,14 @@ Below is a list of platforms that rodo can run on:
 * Windows (Using Windows Subsystem for Linux)
 * macOS (Using [Homebrew](https://brew.sh/))

-# Requirements
+## 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://git.m455.casa/m455/rodo](https://git.m455.casa/m455/rodo)

-# Quick start
+## Quick start

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

 **Note**: You may need to run `rodo ls` to see which number corresponds to which item in your list before running `rodo rm <number>`

-# Downloading rodo
+## Downloading rodo

 rodo'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.

-## Downloading rodo using git
+### Downloading rodo using git

 You can use tools such as `git` to download rodo's source code. You
 will need the source code to install rodo.

-### To download rodo using git
+#### To download rodo using git

 1. Run `git clone https://git.m455.casa/m455/rodo.git`

 **Note**: This will create a `rodo` directory in your current directory.

-# Installing rodo
+## Installing rodo

 You can either install rodo globally or locally on your system. A global installation allows all users on a machine to use rodo, while a local installation only allows one user to use rodo.

@ -122,29 +122,29 @@ See the options below for installing rodo:
 * [Installing rodo locally](#installing-rodo-locally)
 * [Installing rodo to a custom directory](#installing-rodo-to-a-custom-directory)

-## Installing rodo globally
+### Installing rodo globally

 This option will install rodo into `/usr/local/bin/`.

 This section assumes you have [downloaded rodo](#downloading-rodo).

-### To install rodo globally
+#### To install rodo globally

 1. Run `cd rodo`
 2. Run `sudo make install-global`

-## Installing rodo locally
+### Installing rodo locally

 This option will install rodo into `~/.local/bin/`.

 This section assumes you have [downloaded rodo](#downloading-rodo).

-### To install rodo locally
+#### To install rodo locally

 1. Run `cd rodo`
 2. Run `sudo make install-local`

-## Installing rodo to a custom directory
+### Installing rodo to a custom directory

 If you wish to have rodo exist elsewhere on your system, you can also
 build a single-file executable. Building a single-file executable
@ -153,7 +153,7 @@ system, such as a directory on your `$PATH`.

 This section assumes you have [downloaded rodo](#downloading-rodo).

-### To install rodo to a custom directory
+#### To install rodo to a custom directory

 **Warning**: You will have to manually uninstall custom installations

@ -162,7 +162,7 @@ This section assumes you have [downloaded rodo](#downloading-rodo).

 **Example**: In step 2., you could run `make install-custom location=~/bin/`

-# Uninstalling rodo
+## Uninstalling rodo

 Depending on your installation method, you can uninstall a global or local installation of rodo.

@ -171,53 +171,53 @@ See the options below for uninstalling rodo:
 * [Uninstalling rodo globally](#uninstalling-rodo-globally)
 * [Uninstalling rodo locally](#uninstalling-rodo-locally)

-## Uninstalling rodo globally
+### Uninstalling rodo globally

 This option will remove the `rodo` executable from `/usr/local/bin/`.

 This section assumes you have [downloaded rodo](#downloading-rodo).

-### To uninstall rodo globally
+#### To uninstall rodo globally

 1. Run `cd rodo`
 2. Run `sudo make uninstall-global`

-## Uninstalling rodo locally
+### Uninstalling rodo locally

 This option will remove the `rodo` executable from `~/.local/bin/`.

 This section assumes you have [downloaded rodo](#downloading-rodo).

-### To uninstall rodo locally
+#### To uninstall rodo locally

 1. Run `cd rodo`
 2. Run `sudo make uninstall-local`

-# Using rodo
+## Using rodo

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

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

-## Initializing rodo
+### Initializing rodo

 Before using rodo, you will need to initialize it. This means rodo will create a `~/.rodo` file.

-### To initialize rodo
+#### To initialize rodo

 1. Run `rodo init`
 2. Choose `y`

-## 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 name of a command or how to use a command.

-### To show the help message
+#### To show the help message

 1. Run `rodo help`

-## Displaying your list
+### Displaying your list

 Displaying your list will allow you to view the items you have added to your list.
 You will notice numbers beside the items in your list.
@ -225,25 +225,25 @@ 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
+#### To display your list

 1. Run `rodo 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.

-### To add an item to your list
+#### To add an item to your list

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

-## 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 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
+#### To remove an item from your list

 1. Run `rodo rm 1`

@ -253,7 +253,7 @@ list.
 **Note 2**: You may need to run `rodo ls` first to see which numbers correspond
 with which item in your list.

-# List of commands
+## List of commands

 This section lists and describes rodo's commands.

@ -263,7 +263,7 @@ This section lists and describes rodo's commands.
 * `add` adds an item to your list
 * `rm` removes an item from your list

-# Usage examples
+## Usage examples

 `rodo init`