( git://dome.circumlunar.space/~cmccabe/linkulator/README )
( commit 5377059aead5852574c7d5a915c788e1c251f6de )

NOTE: linkulator is now maintained here:
https://tildegit.org/cmccabe/linkulator
(It was moved to facilitate involvement of other developers.)

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
 _ _       _          _       _             _ 
| (_)_ __ | | ___   _| | __ _| |_ ___  _ __| |
| | | '_ \| |/ / | | | |/ _` | __/ _ \| '__| |
| | | | | |   <| |_| | | (_| | || (_) | |  |_|
|_|_|_| |_|_|\_\\__,_|_|\__,_|\__\___/|_|  (_)


=====  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 thoes 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 all the files to 700.

4.  create a file storage directory somewhere, owned by linkulator 
    and chmod'ed to 700.

4.  edit the 'config' file to point to the file storage directory.
    (you can change the other config variables, but don't need to 
    yet).

5.  edit 'linkulator.sh' (line 165'ish) to point to the location
    of the config file.

6.  edit 'wrapper.c' so that it points to the location of 
    'linkulator.sh'

7.  compile 'wrapper.c' to create a 'linkulator' binary:
    gcc -o linkulator wrapper.c

8.  chmod the 'linkulator' executable to 755

9.  make 'linkulator' setuid: chmod u+s linkulator

10. create a symlink to the 'linkulator' executable in a place
    commonly accessible to other user.

11. 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.