updated README

main
m455 2020-01-16 12:54:49 -05:00
parent 955d4adc74
commit 31a03f14bc
13 changed files with 27 additions and 23 deletions

View File

@ -6,18 +6,18 @@ A minimal list manager for people who live on the command line.
![](screenshot.png) ![](screenshot.png)
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
# Table of Contents # Table of Contents
- [Quick Start](#quick-start) - [Quick Start](#quick-start)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Conventions used in this readme](#conventions-used-in-this-readme) - [Conventions used in this readme](#conventions-used-in-this-readme)
- [Platforms](#platforms) - [Platforms](#platforms)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Downloading the Requirements](#downloading-the-requirements)
- [Downloading Racket](#downloading-racket) - [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) - [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) - [Running rodo from Any Directory](#running-rodo-from-any-directory)
- [Setting up a $PATH](#setting-up-a-path) - [Setting up a $PATH](#setting-up-a-path)
- [To set up a $PATH](#to-set-up-a-path) - [To set up a $PATH](#to-set-up-a-path)
@ -27,7 +27,7 @@ A minimal list manager for people who live on the command line.
- [Showing the Help Message](#showing-the-help-message) - [Showing the Help Message](#showing-the-help-message)
- [To Show the Help Message](#to-show-the-help-message) - [To Show the Help Message](#to-show-the-help-message)
- [Initializing rodo](#initializing-rodo) - [Initializing rodo](#initializing-rodo)
- [To Initialize rodo](#to-initialize-rodo) - [To initialize rodo](#to-initialize-rodo)
- [Displaying Your List](#displaying-your-list) - [Displaying Your List](#displaying-your-list)
- [To Display Your List](#to-display-your-list) - [To Display Your List](#to-display-your-list)
- [Adding an Item to Your List](#adding-an-item-to-your-list) - [Adding an Item to Your List](#adding-an-item-to-your-list)
@ -35,10 +35,13 @@ A minimal list manager for people who live on the command line.
- [Removing an Item from Your List](#removing-an-item-from-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) - [To Remove an Item from Your List](#to-remove-an-item-from-your-list)
- [Configuring rodo](#configuring-rodo) - [Configuring rodo](#configuring-rodo)
- [To Configure Rodo](#to-configure-rodo) - [To Configure rodo](#to-configure-rodo)
- [List of commands](#list-of-commands) - [List of commands](#list-of-commands)
- [Usage examples](#usage-examples) - [Usage examples](#usage-examples)
<!-- markdown-toc end -->
# Quick Start # Quick Start
**Note** - This section is for users who are familiar with git, a Unix-like **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 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. 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 * **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
@ -81,7 +84,7 @@ on the command line and want a minimal list manager.
* `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
## Platforms # Platforms
Below is a list of platforms that rodo can run on: 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 * Windows Subsystem for Linux
* macOS (Untested) * 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/) * Racket: [https://racket-lang.org/](https://racket-lang.org/)
* rodo's source code: [https://github.com/m455/rodo](https://github.com/m455/rodo) * 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 ## Downloading Racket
The Racket programming language will be needed to interpret or compile rodo. 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 1. run `sudo apt install racket` on the command line
@ -174,9 +172,10 @@ chmod u+x ~/bin/rodo
# Using rodo # Using rodo
This section will guide you the various commands that rodo can use. This section This section will guide you the various commands that rodo can
assumes you know how to run either the `rodo.rkt` or an executable created with use. This section assumes you know how to run either the `rodo.rkt`
`raco exe rodo.rkt`. using the Racket interpreter (`racket rodo.rkt`) or you have created
an executable using `raco exe rodo.rkt`.
## Showing the Help Message ## 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` `rodo rm 1`
**Note**: You may have to run `rodo ls` to see which number corresponds to which item in your list. **Note**: You may have to run `rodo ls` to see which number corresponds to which item in your list.

View File

@ -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"))

Binary file not shown.

View File

@ -0,0 +1 @@
("7.2" racket ("8fb95af31029541bd5eb695b172972cb79a2ef93" . "2d712c48b3926c946618eb7956919d2aea2cf196") (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt"))

Binary file not shown.

View File

@ -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"))

Binary file not shown.

View File

@ -0,0 +1 @@
("7.2" racket ("065ba24c0934d73675dc0b0163b4701d782dc426" . "af632c462e0b9ace40afb355782b3574ed81c224") #"/home/m455/dev/projects/rodo/config.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt"))

Binary file not shown.

View File

@ -0,0 +1 @@
("7.2" racket ("d9faf989c553afd2ce55873814685091f570d9ce" . "d2dab85830965b39e5ee50276cadbd5de96e68ec") #"/home/m455/dev/projects/rodo/args.rkt" (collects #"racket" #"base.rkt") (collects #"racket" #"runtime-config.rkt"))

Binary file not shown.

View File

@ -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"))

Binary file not shown.