diff --git a/README.md b/README.md index 56af3a6..52b589f 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,18 @@ A minimal list manager for people who live on the command line. ![](screenshot.png) + # Table of Contents - [Quick Start](#quick-start) - [Getting Started](#getting-started) - - [Conventions used in this readme](#conventions-used-in-this-readme) - - [Platforms](#platforms) - - [Requirements](#requirements) -- [Downloading the Requirements](#downloading-the-requirements) +- [Conventions used in this readme](#conventions-used-in-this-readme) +- [Platforms](#platforms) +- [Requirements](#requirements) - [Downloading Racket](#downloading-racket) - - [To Download Racket](#to-download-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) + - [To Download the rodo Source Code](#to-download-the-rodo-source-code) - [Running rodo from Any Directory](#running-rodo-from-any-directory) - [Setting up a $PATH](#setting-up-a-path) - [To set up a $PATH](#to-set-up-a-path) @@ -27,18 +27,21 @@ A minimal list manager for people who live on the command line. - [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) + - [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) + - [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) + - [To Configure rodo](#to-configure-rodo) - [List of commands](#list-of-commands) - [Usage examples](#usage-examples) + + + # Quick Start **Note** - This section is for users who are familiar with git, a Unix-like @@ -72,7 +75,7 @@ This readme will guide you through downloading, setting up, and using the rodo list manager. This readme is intended for people who spend a lot of their time on the command line and want a minimal list manager. -## Conventions used in this readme +# Conventions used in this readme * **Note** - Notes signify additional information * **Tip**- Tips signify an alternate procedure for completing a step @@ -81,7 +84,7 @@ on the command line and want a minimal list manager. * `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: @@ -89,23 +92,18 @@ Below is a list of platforms that rodo can run on: * Windows Subsystem for Linux * macOS (Untested) -## Requirements +# Requirements -The following items must be installed before you can use rodo: +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 the Requirements - -This section will guide you through downloading the required items for running -rodo. - ## Downloading Racket The Racket programming language will be needed to interpret or compile rodo. -### To Download Racket +### To Download and install Racket 1. run `sudo apt install racket` on the command line @@ -174,9 +172,10 @@ chmod u+x ~/bin/rodo # Using rodo -This section will guide you the various commands that rodo can use. This section -assumes you know how to run either the `rodo.rkt` or an executable created with -`raco exe rodo.rkt`. +This section will guide you the various commands that rodo can +use. This section assumes you know how to run either the `rodo.rkt` +using the Racket interpreter (`racket rodo.rkt`) or you have created +an executable using `raco exe rodo.rkt`. ## Showing the Help Message @@ -273,4 +272,3 @@ The examples below assume that you have [added rodo to your $PATH](#adding-rodo- `rodo rm 1` **Note**: You may have to run `rodo ls` to see which number corresponds to which item in your list. - diff --git a/compiled/args_rkt.dep b/compiled/args_rkt.dep new file mode 100644 index 0000000..069c4b5 --- /dev/null +++ b/compiled/args_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("91728cac1c565a0b28dc1defd9f32614950d4d56" . "4335ec5bad2ed36e5152052c5d874e9251a606f4") #"/home/m455/dev/projects/rodo/config.rkt" #"/home/m455/dev/projects/rodo/init.rkt" #"/home/m455/dev/projects/rodo/messages.rkt" #"/home/m455/dev/projects/rodo/utils.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"file.rkt") (collects #"racket" #"runtime-config.rkt")) diff --git a/compiled/args_rkt.zo b/compiled/args_rkt.zo new file mode 100644 index 0000000..f5d317d Binary files /dev/null and b/compiled/args_rkt.zo differ diff --git a/compiled/config_rkt.dep b/compiled/config_rkt.dep new file mode 100644 index 0000000..568fa59 --- /dev/null +++ b/compiled/config_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("8fb95af31029541bd5eb695b172972cb79a2ef93" . "2d712c48b3926c946618eb7956919d2aea2cf196") (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt")) diff --git a/compiled/config_rkt.zo b/compiled/config_rkt.zo new file mode 100644 index 0000000..6979414 Binary files /dev/null and b/compiled/config_rkt.zo differ diff --git a/compiled/init_rkt.dep b/compiled/init_rkt.dep new file mode 100644 index 0000000..765bb86 --- /dev/null +++ b/compiled/init_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("f9052833e5e674ee3a5a287c324e153de4040d49" . "3f28e2d1c2783c26a0ee7a0d76b510b5852d3855") #"/home/m455/dev/projects/rodo/config.rkt" #"/home/m455/dev/projects/rodo/messages.rkt" #"/home/m455/dev/projects/rodo/utils.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt")) diff --git a/compiled/init_rkt.zo b/compiled/init_rkt.zo new file mode 100644 index 0000000..136a85f Binary files /dev/null and b/compiled/init_rkt.zo differ diff --git a/compiled/messages_rkt.dep b/compiled/messages_rkt.dep new file mode 100644 index 0000000..04040a3 --- /dev/null +++ b/compiled/messages_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("065ba24c0934d73675dc0b0163b4701d782dc426" . "af632c462e0b9ace40afb355782b3574ed81c224") #"/home/m455/dev/projects/rodo/config.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt")) diff --git a/compiled/messages_rkt.zo b/compiled/messages_rkt.zo new file mode 100644 index 0000000..7c95fcb Binary files /dev/null and b/compiled/messages_rkt.zo differ diff --git a/compiled/rodo_rkt.dep b/compiled/rodo_rkt.dep new file mode 100644 index 0000000..2eca233 --- /dev/null +++ b/compiled/rodo_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("d9faf989c553afd2ce55873814685091f570d9ce" . "d2dab85830965b39e5ee50276cadbd5de96e68ec") #"/home/m455/dev/projects/rodo/args.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt")) diff --git a/compiled/rodo_rkt.zo b/compiled/rodo_rkt.zo new file mode 100644 index 0000000..8962aa4 Binary files /dev/null and b/compiled/rodo_rkt.zo differ diff --git a/compiled/utils_rkt.dep b/compiled/utils_rkt.dep new file mode 100644 index 0000000..555beec --- /dev/null +++ b/compiled/utils_rkt.dep @@ -0,0 +1 @@ +("7.2" racket ("15d9472d94a02a35cf42de5d6e217e38aed2b3b0" . "2a188547c9e553c696f05976cee356c1da556496") #"/home/m455/dev/projects/rodo/config.rkt" #"/home/m455/dev/projects/rodo/messages.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"file.rkt") (collects #"racket" #"list.rkt") (collects #"racket" #"runtime-config.rkt") (collects #"racket" #"string.rkt")) diff --git a/compiled/utils_rkt.zo b/compiled/utils_rkt.zo new file mode 100644 index 0000000..fb33b40 Binary files /dev/null and b/compiled/utils_rkt.zo differ