summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMitja Felicijan <m@mitjafelicijan.com>2023-05-20 19:42:48 +0000
committerMitja Felicijan <m@mitjafelicijan.com>2023-05-20 19:42:48 +0000
commit36dd2ba3e45f618d978c169729ee0a59c85cbef0 (patch)
tree4534880c5317511e9c89e2c67eb55187ab6d71c0 /README.md
parent917aa28cbd5cf3c1fd656d012c46e2e1a267a10b (diff)
downloadp9tree-36dd2ba3e45f618d978c169729ee0a59c85cbef0.tar.gz
Added more detailed readme file
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index a8bbd09..95857b4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
# Plan9 tree util
+`tree` is written with Plan9 Operating System in mind so it may not work
+with other systems.
+
+It is using [Plan9 C compiler](https://plan9.io/sys/doc/compiler.html).
+
+## Description
+
+Tree is a recursive directory listing program that displays files in a
+hierarchical structure with indentation based on their depth. The program
+outputs the listing to the terminal.
+
+If no arguments are provided, tree lists all the files in the current
+directory. When directory arguments are given, tree lists all the files and
+directories found within each specified directory.
+