aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorSam Anthony <sam@samanthony.xyz>2023-02-03 18:20:02 -0330
committerSam Anthony <sam@samanthony.xyz>2023-02-03 18:20:02 -0330
commit0ba1f5aa16dd068c4355f9ea486ab5f92afb1104 (patch)
tree12933d7c61c534972f580f5c42bd9a110a2bf490 /README
parent14c12c031c66a56d467f0894468a1ec353a12cae (diff)
downloadpfc-0ba1f5aa16dd068c4355f9ea486ab5f92afb1104.zip
update readmev0.3.3
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 28 insertions, 1 deletions
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