updated readme
Jesse Laprade
parent
793896ede5
commit
637ac01701
2
Makefile
2
Makefile
|
|
@ -19,7 +19,7 @@ help:
|
||||||
@echo "This Makefile supports the following commands:"
|
@echo "This Makefile supports the following commands:"
|
||||||
@echo " help - Displays this help message"
|
@echo " help - Displays this help message"
|
||||||
@echo " clean - Removes any $(file-executable) executable from $(directory-source)/"
|
@echo " clean - Removes any $(file-executable) executable from $(directory-source)/"
|
||||||
@echo " build - Creates a $(file-executable) in your current directory"
|
@echo " build - Creates a $(file-executable) executable in your current directory"
|
||||||
@echo " install-global - Installs a $(file-executable) executable in $(directory-global)/"
|
@echo " install-global - Installs a $(file-executable) executable in $(directory-global)/"
|
||||||
@echo " uninstall-global - Deletes a $(file-executable) executable from $(directory-global)/"
|
@echo " uninstall-global - Deletes a $(file-executable) executable from $(directory-global)/"
|
||||||
@echo " install-local - Installs a $(file-executable) executable in $(directory-local)/"
|
@echo " install-local - Installs a $(file-executable) executable in $(directory-local)/"
|
||||||
|
|
|
||||||
169
README.md
169
README.md
|
|
@ -4,8 +4,6 @@ rodo is a todo-list program for the command line.
|
||||||
|
|
||||||
Todo:
|
Todo:
|
||||||
|
|
||||||
- [X] Learn the basics of Makefiles
|
|
||||||
- [X] Make a Makefile
|
|
||||||
- [ ] Update the `README.md` to match the new `Makefile`
|
- [ ] Update the `README.md` to match the new `Makefile`
|
||||||
- [ ] Remove `install.sh` and `uninstall.sh` scripts after the `README.md` is updated
|
- [ ] Remove `install.sh` and `uninstall.sh` scripts after the `README.md` is updated
|
||||||
|
|
||||||
|
|
@ -15,20 +13,26 @@ Todo:
|
||||||
|
|
||||||
# Table of Contents
|
# Table of Contents
|
||||||
|
|
||||||
- [About this document](#about-this-document)
|
- [Disclaimer](#disclaimer)
|
||||||
- [Conventions used in this document](#conventions-used-in-this-document)
|
- [Conventions used in this document](#conventions-used-in-this-document)
|
||||||
- [Platforms](#platforms)
|
- [Platforms](#platforms)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
- [Downloading Racket](#downloading-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)
|
|
||||||
- [Quick start](#quick-start)
|
- [Quick start](#quick-start)
|
||||||
- [Getting started](#getting-started)
|
- [Downloading rodo](#downloading-rodo)
|
||||||
- [Installing rodo](#installing-rodo)
|
- [Downloading rodo using git](#downloading-rodo-using-git)
|
||||||
- [To install rodo](#to-install-rodo)
|
- [To download rodo using git](#to-download-rodo-using-git)
|
||||||
- [Uninstalling rodo](#uninstalling-rodo)
|
- [Installing rodo](#installing-rodo)
|
||||||
- [To uninstall rodo](#to-uninstall-rodo)
|
- [Installing rodo globally](#installing-rodo-globally)
|
||||||
|
- [To install rodo globally](#to-install-rodo-globally)
|
||||||
|
- [Installing rodo locally](#installing-rodo-locally)
|
||||||
|
- [To install rodo locally](#to-install-rodo-locally)
|
||||||
|
- [Installing rodo to a custom directory](#installing-rodo-to-a-custom-directory)
|
||||||
|
- [To install rodo to a custom directory](#to-install-rodo-to-a-custom-directory)
|
||||||
|
- [Uninstalling rodo](#uninstalling-rodo)
|
||||||
|
- [Uninstalling rodo globally](#uninstalling-rodo-globally)
|
||||||
|
- [To uninstall rodo globally](#to-uninstall-rodo-globally)
|
||||||
|
- [Uninstalling rodo locally](#uninstalling-rodo-locally)
|
||||||
|
- [To uninstall rodo locally](#to-uninstall-rodo-locally)
|
||||||
- [Using rodo](#using-rodo)
|
- [Using rodo](#using-rodo)
|
||||||
- [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)
|
||||||
|
|
@ -45,12 +49,14 @@ Todo:
|
||||||
- [List of commands](#list-of-commands)
|
- [List of commands](#list-of-commands)
|
||||||
- [Usage examples](#usage-examples)
|
- [Usage examples](#usage-examples)
|
||||||
|
|
||||||
# About this document
|
# Disclaimer
|
||||||
|
|
||||||
This document will guide you through downloading, installing, and using rodo.
|
This is a hobby project I built for myself to keep track of todos
|
||||||
|
related to my hobbies.
|
||||||
|
|
||||||
This document assumes you have basic command line skills, such as navigating
|
I take no responsibility for anything that rodo deletes.
|
||||||
directories, and editing files.
|
|
||||||
|
Backup anything you don't want deleted.
|
||||||
|
|
||||||
# Conventions used in this document
|
# Conventions used in this document
|
||||||
|
|
||||||
|
|
@ -66,8 +72,8 @@ directories, and editing files.
|
||||||
Below is a list of platforms that rodo can run on:
|
Below is a list of platforms that rodo can run on:
|
||||||
|
|
||||||
* GNU/Linux
|
* GNU/Linux
|
||||||
* Windows Subsystem for Linux
|
* Windows (Using Windows Subsystem for Linux)
|
||||||
* macOS (Untested)
|
* macOS (Using [Homebrew](https://brew.sh/))
|
||||||
|
|
||||||
# Requirements
|
# Requirements
|
||||||
|
|
||||||
|
|
@ -76,22 +82,6 @@ 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 Racket
|
|
||||||
|
|
||||||
The Racket programming language will be needed to create a single-file executable
|
|
||||||
|
|
||||||
### To download and install Racket
|
|
||||||
|
|
||||||
1. Run `sudo apt install racket` on the command line
|
|
||||||
|
|
||||||
## Downloading the rodo source code
|
|
||||||
|
|
||||||
rodo's source code is needed so Racket's `raco` tool can create a single-file executable
|
|
||||||
|
|
||||||
### To download the rodo source code
|
|
||||||
|
|
||||||
1. Run `git clone https://github.com/m455/rodo`
|
|
||||||
|
|
||||||
# Quick start
|
# Quick start
|
||||||
|
|
||||||
This section is for users who are familiar with git, a Unix-like command line environment, or
|
This section is for users who are familiar with git, a Unix-like command line environment, or
|
||||||
|
|
@ -100,43 +90,118 @@ scripting.
|
||||||
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`
|
2. `git clone https://github.com/m455/rodo`
|
||||||
3. `cd rodo`
|
3. `cd rodo`
|
||||||
4. `sudo ./install.sh`
|
4. `sudo make install-global`
|
||||||
5. `rodo`
|
5. `rodo`
|
||||||
|
|
||||||
**Note**: To uninstall, run `sudo ./uninstall.sh`
|
**Note**: To uninstall, run `sudo make uninstall-global`
|
||||||
|
|
||||||
# Getting started
|
* `rodo help` - Displays the help message
|
||||||
|
* `rodo init` - Generates the directory and file required in your home folder, so rodo can operate
|
||||||
|
* `rodo add "your task here"` - Adds the message inside of quotation marks to your todo list
|
||||||
|
* `rodo ls` - Displays your todo list
|
||||||
|
* `rodo rm 2` - Removes the third item from your list. (The list starts at 0)
|
||||||
|
|
||||||
This section will guide you through settig up rodo.
|
**Note**: You may need to run `rodo ls` to see which number corresponds to which item in your list before running `rodo rm <number>`
|
||||||
|
|
||||||
**Note**: This section assumes you have already [downloaded the rodo source code](#downloading-the-rodo-source-code).
|
# Downloading rodo
|
||||||
|
|
||||||
## Installing 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.
|
||||||
|
|
||||||
Installing rodo will add a rodo executable to the `/usr/local/bin` directory. This allows users to
|
## Downloading rodo using git
|
||||||
run rodo from any directory on their system.
|
|
||||||
|
|
||||||
**Note**: Writing to the `/usr/local/bin` directory requires root privileges.
|
You can use tools such as `git` to download rodo's source code. You
|
||||||
|
will need the source code to install rodo.
|
||||||
|
|
||||||
### To install rodo
|
### To download rodo using git
|
||||||
|
|
||||||
1. Change to the directory you downloaded rodo into
|
1. Run `git clone https://github.com/m455/rodo`
|
||||||
2. Run `sudo ./install.sh`
|
|
||||||
|
|
||||||
## Uninstalling rodo
|
**Note**: This will create a `rodo` directory in your current directory.
|
||||||
|
|
||||||
Uninstalling rodo removes the rodo executable from the `/usr/local/bin` directory.
|
# Installing rodo
|
||||||
|
|
||||||
### To uninstall 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.
|
||||||
|
|
||||||
1. Change to the directory you downloaded rodo into
|
See the options below for installing rodo:
|
||||||
2. Run `sudo ./uninstall`
|
|
||||||
|
* [Installing rodo globally](#installing-rodo-globally)
|
||||||
|
* [Installing rodo locally](#installing-rodo-locally)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
1. Run `cd rodo`
|
||||||
|
2. Run `sudo make install-global`
|
||||||
|
|
||||||
|
## Installing rodo locally
|
||||||
|
|
||||||
|
This option will install rodo into `~/.local/bin/`.
|
||||||
|
|
||||||
|
This section assumes you have [downloaded rodo](#downloading-rodo).
|
||||||
|
|
||||||
|
### To install rodo locally
|
||||||
|
|
||||||
|
1. Run `cd rodo`
|
||||||
|
2. Run `sudo make install-local`
|
||||||
|
|
||||||
|
## 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
|
||||||
|
allows you to place the executable in convenient places on your
|
||||||
|
system, such as a directory on your `$PATH`.
|
||||||
|
|
||||||
|
This section assumes you have [downloaded rodo](#downloading-rodo).
|
||||||
|
|
||||||
|
### To install rodo to a custom directory
|
||||||
|
|
||||||
|
1. Run `cd rodo`
|
||||||
|
2. Run `make build`
|
||||||
|
3. Move the `rodo` single-file executable to your desired directory
|
||||||
|
|
||||||
|
# Uninstalling rodo
|
||||||
|
|
||||||
|
Depending on your installation method, you can uninstall a global or local installation of rodo.
|
||||||
|
|
||||||
|
See the options below for uninstalling rodo:
|
||||||
|
|
||||||
|
* [Uninstalling rodo globally](#uninstalling-rodo-globally)
|
||||||
|
* [Uninstalling rodo locally](#uninstalling-rodo-locally)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
1. Run `cd rodo`
|
||||||
|
2. Run `sudo make uninstall-global`
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
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 will teach you how to use rodo's commands.
|
||||||
|
|
||||||
**Note**: This section assumes you have [installed rodo](#installing-rodo).
|
This section assumes you have [installed rodo](#installing-rodo).
|
||||||
|
|
||||||
## Showing the help message
|
## Showing the help message
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue