Commit ad4b1e59 authored by mbionchi's avatar mbionchi

add autotools build files, update docs

parent d38de8ba
This diff is collapsed.
This diff is collapsed.
SUBDIRS = src
dist_doc_DATA = README
...@@ -16,9 +16,15 @@ The syntax is described in the FORMATTING section. ...@@ -16,9 +16,15 @@ The syntax is described in the FORMATTING section.
Both the text window as well as the file index window are scrollable. Both the text window as well as the file index window are scrollable.
BUILDING BUILDING
--------- --------
gcc -lncurses site.c scroll.c render.c data.c If you have autotools, you can just run
./autogen.sh
and then do the normal `./configure && make && make install` with your favourite
flags.
Otherwise, you can run
gcc -o telnetsite -lncurses ./src/*.c
SERVING OVER TELNET SERVING OVER TELNET
------------------- -------------------
...@@ -40,9 +46,9 @@ mytelnetsite stream tcp nowait <user> /usr/sbin/tcpd /usr/sbin/telnetd -h -E <pa ...@@ -40,9 +46,9 @@ mytelnetsite stream tcp nowait <user> /usr/sbin/tcpd /usr/sbin/telnetd -h -E <pa
with the following: with the following:
#!/bin/sh #!/bin/sh
exec <path-to-a.out> <path-to-site.d> exec <path-to-binary> <path-to-site.d>
where <path-to-a.out> is the path to the telnet-site executable, and where <path-to-binary> is the path to the telnet-site executable, and
<path-to-site.d> is the path to the root directory of the site. <path-to-site.d> is the path to the root directory of the site.
FORMATTING FORMATTING
...@@ -71,3 +77,9 @@ will be aligned to the first letter character on this line, for example: ...@@ -71,3 +77,9 @@ will be aligned to the first letter character on this line, for example:
item item
number number
one one
BUGS
----
- sometimes scrolling breaks over telnet or seems to assume invalid terminal size
- flow algo segfaults if a contiguos word is longer that the paragraph max width
TODO
====
- figure out how to get rid of the wrapper script or
add one to the distribution
- pretty up the rendering/scrolling code
- add directory support
- add WINCH support (idk if it even transfers over telnet)
- maybe add file caching
- maybe add inotify support for live directory indexing
- add a way to do animations (either via frames or executable load)
#!/bin/sh
autoreconf --install --force
AC_INIT([telnet-site], [0.4], [https://gitlab.com/mb])
AM_INIT_AUTOMAKE([foreign])
AC_CONFIG_SRCDIR([configure.ac])
AC_PROG_CC
AC_CONFIG_FILES([Makefile src/Makefile])
PKG_CHECK_MODULES([ncurses], [ncurses])
AC_OUTPUT
bin_PROGRAMS = telnetsite
telnetsite_SOURCES = site.c data.c data.h scroll.c scroll.h render.c render.h
telnetsite_LDADD = ${ncurses_LIBS}
AM_CFLAGS = -Isrc/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment