aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2026-04-15 03:45:24 +0700
committerShulhan <ms@kilabit.info>2026-04-15 03:45:24 +0700
commit6888dd812e73f77081834868a667c8a850ebc4a9 (patch)
tree684929ce73f8cd11bde9023357529c090580a85b /README.md
parent54a1b4c74885bab75b382ec0f3aa46ed74fd3181 (diff)
downloadvos-main.tar.xz
all: add README to the root of repositoryHEADmain
Convert the README.adoc to markdown so it can be rendered.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b44e6f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# vos
+
+Vos is a program to process formatted data, i.e. CSV data.
+Vos is designed to process a large input file, a file where their size is
+larger than the size of memory, and can be tuned to adapt with your machine
+environment.
+
+[Vos User Manual](https://kilabit.info/project/vos/user/vos_user_manual.html) -
+User manual for vos command line.
+
+## Development
+
+[GOAL](https://kilabit.info/project/vos/dev/GOAL.html) - List the goal of this
+project.
+
+[NOTES](https://kilabit.info/project/vos/dev/NOTES.html) - Miscellaneous notes
+when developing the project.
+
+[Vos sketch diagram](https://kilabit.info/project/vos//dev/vos-sketch.odg).
+
+Performance logs,
+
+- [vos.test.create.log](https://kilabit.info/project/vos/dev/vos.test.create.log).
+- [vos.test.create.mem.log](https://kilabit.info/project/vos/dev/vos.test.create.mem.log).
+- [vos.test.join.log](https://kilabit.info/project/vos/dev/vos.test.join.log).
+- [vos.test.join.log](https://kilabit.info/project/vos/dev/vos.test.join.log).