Hold your horses! Don't get too excited!  This is a very early, 
and rather sloppy, collection of files that might (given a bit of 
luck) be able to run on your system.  But really, this is released 
in attempt to attract additional developer support from the 
community.

If you would like to help, contact cmccabe@sdf.org

                                                /\
  _ _    the_link aggreGator   _                **
 | (_)_ __ | | ___   _| | __ _| |_ ___  _ __  \_}}_/
 | | | '_ \| |/ / | | | |/ _` | __/ _ \| '__|   {{
 | | | | | |   <| |_| | | (_| | || (_) | |    \_}}_/
 |_|_|_| |_|_|\_\\__,_|_|\__,_|\__\___/|_|      {{   ,
                                                 >>>^

=====  WHAT IS IT?  =====

Linkulator is a command line link aggregator; like 
news.ycombinator.com, or lobste.rs, but strictly for the command 
line.  But unlike those two, Linkulator natively supports both 
gopher and http links.  Like the others, Linkulator allows the 
poster or others to leave comments about the posted link. It was 
designed for small public access Unix (and GNU/Linux!) communities 
like Circumlunar Space, Grex, or the many servers in the 
Tildeverse (tilde.team, tilde.town and so on).


=====  HOW TO INSTALL IT?  =====

Installation is still in flux and is very experimental.  Below is 
one way it has been successfully installed, but your help on 
designing a better process would be valuable.

1.  Create a linkulator user (this is important because Linkulator 
    runs setuid).

2.  Copy all the files to the linkulator user's directory, or to 
    any directory under the linkulator user's control.

3.  chmod linkulator.sh to 655, and the rest of the files to 644:
    chmod 644 * && chmod 755 linkulator.sh

4.  Create a file storage directory somewhere, owned by linkulator 
    and chmod'ed to 755:
    mkdir filedir && chown linkulator filedir && chmod 755 filedir

5.  Edit the 'config' file and set PROGDIR to the location of the
    linkulator files (linkulator.sh, config and writer).
    Also set FILEPATH to the location of the file storage directory.
    (you can change the other config variables, but don't need to 
    yet).

6.  Edit 'linkulator.sh' (line 166'ish) to point to the location
    of the config file.

7.  Compile 'writer.c' to create a 'writer' binary:
    gcc -o writer writer.c

8.  Set 'writer' setuid attribute: chmod u+s writer

9.  Create a symlink to the 'linkulator.sh' script in a place
    commonly accessible to other users.

10. linkulate. 


=====  REPORT BUGS OR HELP DEVELOP  =====

BUGS - send bug reports to cmccabe@sdf.org.  Please be as 
descriptive as possible about what happened and what you think 
might have caused it -- including possible solutions if you have 
such an idea.

HELP - if you want to help, start by cloning the repo and adding 
your name to the AUTHORS variable in the 'config' file.