From 4fc5aa8713d2d43b2d393fb318382dd674c5fbbe Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Fri, 17 Apr 2020 21:12:50 -0400 Subject: README.md -> README --- README | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 71 --------------------------------------------------------------- 2 files changed, 71 insertions(+), 71 deletions(-) create mode 100644 README delete mode 100644 README.md diff --git a/README b/README new file mode 100644 index 0000000..3c1309e --- /dev/null +++ b/README @@ -0,0 +1,71 @@ +# nserver + +A nihilistic stats server written is part of reading Learn C the +Harday. + + +## compiling + +You'll need a C compiler (clang or gcc), the [gdbm][1] library and +[GNU make][2]. + +[1]: https://www.gnu.org.ua/software/gdbm +[2]: https://www.gnu.org/software/make + +To compile the server, do: + +``` +make +``` + +To compile a debuggable version of the server, do: + +``` +make dev +``` + +The usual: + +``` +make clean +``` + +clean up things. + + +## statserve + +To start this server, do: + +``` +./bin/statserve +``` + +It'll be listening on port 7899. + +You can connect as a client to the server via `nc`: + +``` +nc 127.0.0.1 7899 +``` + + +### client commands + +Recognized commands: + + +``` +/create NAME +/sample NAME +/mean NAME +/dump NAME +/list +/store NAME +/load NAME ANOTHER_NAME +``` + +The `/store` command stores `NAME` in a persistent database on the disk. + +The `/load` command loads the `NAME` from the persistent database into +memory at ANOTHER_NAME. diff --git a/README.md b/README.md deleted file mode 100644 index 3c1309e..0000000 --- a/README.md +++ /dev/null @@ -1,71 +0,0 @@ -# nserver - -A nihilistic stats server written is part of reading Learn C the -Harday. - - -## compiling - -You'll need a C compiler (clang or gcc), the [gdbm][1] library and -[GNU make][2]. - -[1]: https://www.gnu.org.ua/software/gdbm -[2]: https://www.gnu.org/software/make - -To compile the server, do: - -``` -make -``` - -To compile a debuggable version of the server, do: - -``` -make dev -``` - -The usual: - -``` -make clean -``` - -clean up things. - - -## statserve - -To start this server, do: - -``` -./bin/statserve -``` - -It'll be listening on port 7899. - -You can connect as a client to the server via `nc`: - -``` -nc 127.0.0.1 7899 -``` - - -### client commands - -Recognized commands: - - -``` -/create NAME -/sample NAME -/mean NAME -/dump NAME -/list -/store NAME -/load NAME ANOTHER_NAME -``` - -The `/store` command stores `NAME` in a persistent database on the disk. - -The `/load` command loads the `NAME` from the persistent database into -memory at ANOTHER_NAME. -- cgit v1.2.3