Commit: 6fc13c8a0dc3bf8d368d5612f5e6c3db3f59902e
Parent: 11eb318f96ed9160fd3c125673a6c8e2dcf12af6
Author: 0x766F6964
Date: Tue, 5 May 2020 12:25:08 -0600
add README
also remove NOTES and TODO
Diffstat:
| D | NOTES | | | 43 | ------------------------------------------- |
| A | README.md | | | 28 | ++++++++++++++++++++++++++++ |
| D | TODO | | | 2 | -- |
3 files changed, 28 insertions(+), 45 deletions(-)
diff --git a/NOTES b/NOTES
@@ -1,43 +0,0 @@
-This program should create a random playlist based on the folders
-in a dir. I.E. we don't want to shuffle by episode (or song) we want
-to shuffle by series (or album). This will be done recursively with a
-binary tree. The tree will contain a path field, an included field (has
-this path been added to the list yet?), and a pointer to the next node.
-
-For now we will make the top level dir configurable only at compile
-time. And the program will only provide a shuffled list (maybe this
-could be a commandline flag in the future).
-
-The algorithm will be fairly simple and ineffiecent for now but could
-be improved later.
-
-In the future:
-- Specify top level dir on commandline?
-- Toggle shuffling?
-
-Tree Layout:
-If we have a dir layout like this:
-a
-a/b
-a/b/c
-a/d
-a/e/f
-
-The tree should look like this:
-
- a
- |
- |
- > b
- |
- |
- > c
- |
- |
- d <
- |
- v
- e
- |
- |
- > f
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+dir2list
+========
+shuffle subdirs and write filenames to stdout
+
+Dependencies
+------------
+* POSIX Compliant C Library
+* ANSI/C89 C compiler
+
+Tested on `x86_64-linux-musl` but it should work elsewhere.
+
+Install
+-------
+Edit `config.mk` and `config.h` to your liking and run make. Then to
+install, using elevated privileges if neccesary:
+```
+make
+doas make install
+```
+
+Limitations
+-----------
+* Speed
+ - Probably gets slow with very large deeply nested directories.
+* Race Conditions
+ - No mechanism is put in place to handle the addition and
+ removal of files from working directories during operation.
+
diff --git a/TODO b/TODO
@@ -1,2 +0,0 @@
-- Sort Directory entries
-- FIXME note