A CLI tool for non-hierarchical file organization.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
rhipsalis sulcata 7c647bf187 make soup monad 1 week ago
src make soup monad 1 week ago
CHANGELOG.md initial commit 1 week ago
LICENSE initial commit 1 week ago
Main.hs initial commit 1 week ago
README initial commit 1 week ago
Setup.hs initial commit 1 week ago
TODO.org update TODO 1 week ago
planning initial commit 1 week ago
release.nix initial commit 1 week ago
result make soup monad 1 week ago
shell.nix initial commit 1 week ago
soup.cabal make soup monad 1 week ago
soup.db add initial mv bowl command 1 week ago
soup.nix make soup monad 1 week ago
spec initial commit 1 week ago

README

soup
----

"I'm at soup!"
-- Kururugi Suzaku, code ment


what is soup?
-------------
`soup` is a cli tool for tagging files.


why is soup?
------------
Filesystems generally organize files in a hierarchical tree,
which is great for most purposes. However, there are times
when you have a large collection of files (e.g. music, papers, etc)
and there isn't a sensible way to hierarchically order them.
If you just store them in a big pool, then it'll be hard to
search through all those files. `soup` allows you to make such
collections more searchable via tagging. The name "soup" comes
from the fact that a big, amorphous collection of files can be
thought of as an unstructured "soup" of data.

Here's an example of how you could use `soup`: Let's say you
have a ton of research papers on your computer. Lots of papers
list "keywords" near the abstract, so you could write a script
that tags each paper with its keywords. Then, you can use soup
to search for papers /by keyword/. If you've got lots of papers,
this makes searching them much easier, to the point where you can
set up a search system similar to what arxiv.org has.


how to build
------------
TODO


contributing
------------
If you want to contribute or have an idea, send me an email or ping
me on fedi before doing a pull request. If we talk things over more,
then your contribution is more likely to get merged. Don't be afraid
to ask questions, either.


documentation
-------------
documentation can be found here: TODO