aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Cargo.lock2
-rw-r--r--Cargo.toml2
-rw-r--r--README29
3 files changed, 30 insertions, 3 deletions
diff --git a/Cargo.lock b/Cargo.lock
index ff77a3c..e4041d0 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -113,7 +113,7 @@ dependencies = [
[[package]]
name = "pfc"
-version = "0.3.2"
+version = "0.3.3"
dependencies = [
"crossterm",
"tui",
diff --git a/Cargo.toml b/Cargo.toml
index 312e03e..a4976cf 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "pfc"
-version = "0.3.2"
+version = "0.3.3"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
diff --git a/README b/README
index 11924c4..b9f5060 100644
--- a/README
+++ b/README
@@ -1 +1,28 @@
-Postfix Calculator
+pfc - postfix calculator
+========================
+pfc is an interactive postfix / reverse Polish notation calculator for the
+terminal.
+
+
+Requirements
+------------
+Cargo, the Rust package manager, is required to build pfc.
+It can be installed from most Linux package managers or like so:
+
+ curl https://sh.rustup.rs -sSf | sh
+
+
+Installation
+------------
+Edit config.mk to change where pfc will be installed (/usr/local by default).
+
+Enter the following (as root) to build and install pfc:
+
+ make install
+
+
+Usage
+-----
+See the man page for details:
+
+ man pfc