From f71014d06c1ba394ac10f7e99e93c38e175457ca Mon Sep 17 00:00:00 2001 From: m455 Date: Thu, 26 Mar 2020 20:20:01 -0400 Subject: [PATCH] updated readme --- README.md | 37 +++++++++++++++++++------------------ 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index e5fe743..cc9f7fd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,7 @@ # rodo -rodo is a list-management tool for people who prefer to use the command line. - -This document serves as a reference for operating rodo. This document -assumes you have basic command line skills. - -If you are experienced in setting up software projects, you can skip to the [Quick start](#quick-start) section. +This document will guide you through downloading, installing, and using rodo. This document assumes +you have basic command line skills. # Screenshot @@ -13,7 +9,7 @@ If you are experienced in setting up software projects, you can skip to the [Qui # Table of Contents -- [Quick start](#quick-start) +- [Description](#description) - [Conventions used in this readme](#conventions-used-in-this-readme) - [Platforms](#platforms) - [Requirements](#requirements) @@ -21,6 +17,7 @@ If you are experienced in setting up software projects, you can skip to the [Qui - [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) @@ -42,18 +39,9 @@ If you are experienced in setting up software projects, you can skip to the [Qui - [List of commands](#list-of-commands) - [Usage examples](#usage-examples) -# Quick start +# Description -**Note** - 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` +rodo is a list-management tool for people who prefer to use the command line. # Conventions used in this readme @@ -95,6 +83,19 @@ rodo's source code is needed so Racket's `raco` tool can create a single-file ex 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.