tildetown
/
rodo
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme and created a new branch for cleaning up args.rkt

main
m455 2019-06-08 10:03:04 -04:00
parent 221c5bb8a4
commit 9d074aa894
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -8,11 +8,14 @@ A easy-to-use todo list program for people who live on the command line
# Table of Contents # Table of Contents
- [rodo](#rodo)
- [Screenshot](#screenshot)
- [TL;DR](#tldr) - [TL;DR](#tldr)
- [New things](#new-things) - [New things](#new-things)
- [Todos](#todos) - [Todos](#todos)
- [Platforms](#platforms) - [Platforms](#platforms)
- [Requirements](#requirements) - [Installing rodo](#installing-rodo)
- [Requirements](#requirements)
- [Downloading Racket](#downloading-racket) - [Downloading Racket](#downloading-racket)
- [To download Racket using apt](#to-download-racket-using-apt) - [To download Racket using apt](#to-download-racket-using-apt)
- [To download Racket using pacman](#to-download-racket-using-pacman) - [To download Racket using pacman](#to-download-racket-using-pacman)
@ -32,7 +35,7 @@ A easy-to-use todo list program for people who live on the command line
1. Make sure [Racket](https://racket-lang.org/) is installed 1. Make sure [Racket](https://racket-lang.org/) is installed
2. `git clone https://github.com/m455/rodo` into a directory of your choice 2. `git clone https://github.com/m455/rodo` into a directory of your choice
3. `cd` into the `rodo` directory 3. `cd` into the `rodo` directory
4. Run one of the following commands: 4. Choose one of the options below for running `rodo`.
* To use `rodo` using the Racket interpreter run: `racket rodo.rkt` * To use `rodo` using the Racket interpreter run: `racket rodo.rkt`
* To use `rodo` as an single-file executable follow the two steps below: * To use `rodo` as an single-file executable follow the two steps below:
1. Run `raco exe rodo.rkt` to compile the `rodo` into a single-file executable 1. Run `raco exe rodo.rkt` to compile the `rodo` into a single-file executable
@ -58,18 +61,22 @@ Now the default directory and todo list file have better default permissions:
When I have time, I plan on adding the following features to rodo: When I have time, I plan on adding the following features to rodo:
- Add color option to `config.rkt` file - Add a purpose, context, and overview for each h1 in `README.md`
- Encrypt `todo.txt` file - A boolean color option in the `config.rkt` file
- Encrypt/decrypt `todo.txt` file
# Platforms # Platforms
Below is a list of platforms that `rodo` can run on. Below is a list of platforms that `rodo` can run on.
* Windows Subsystem for Linux * Windows Subsystem for Linux
* GNU/Linux (Untested) * GNU/Linux
* macOS (Untested) * macOS (Untested)
# Requirements # Installing rodo
This section will guide you through installing `rodo`, so you can use it on your platform.
## Requirements
This section will provide you with the requirements needed to run `rodo`. This This section will provide you with the requirements needed to run `rodo`. This
section will guide you through downloading Racket and downloading the `rodo` section will guide you through downloading Racket and downloading the `rodo`