cmccabe
/
linkulator2
4
10
Fork 4
Code Issues 21 Pull Requests 3 Releases Wiki Activity

Added some additional information to the README

This commit is contained in:
asdf 2020-01-09 14:39:17 +11:00
parent dae6897d14
commit 0fe98f37cc
1 changed files with 48 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,5 +1,29 @@
# Linkulator, a link aggregator for the shell
Linkulator is a command line link aggregator; somewhat like [news.ycombinator.com](https://news.ycombinator.com), or [lobste.rs](https://lobste.rs), but simpler and run from the command line.
Designed for multi-user systems like [rawtext.club](https://rawtext.club), each user's links and comments are stored in their home directory, and are compiled for viewing when Linkulator is started.
```shell
user@server:~$ linkulator
----------
LINKULATOR
----------
ID# New Category
1 x non-commercial www (9)
2 x how to (1)
3 data (1)
4 software (2)
5 pubnixes (8)
6 music (2)
7 test (13)
8 programming languages (7)
9 search engines (4)
Enter a category ID, p to post a link, s to search, or q to quit:
```
## Installation
Just clone this repo into any location in users' paths. Each user can have their own copy, in case they want to customize it, or you can install a central version in /usr/local/bin.
@ -7,8 +31,11 @@ Just clone this repo into any location in users' paths. Each user can have thei
On most systems, the default configurations should just work (tm), but follow the config steps below if not.
## Configuration
### Default Path settings
These options can be found in *config.py* in the class *DefaultPaths*
In the case where you have a custom location for user home directories, or want to change where Linkulator stores user data, Linkulator's default settings can be easily changed to support this. The following options are found in the file *config.py* in the class *DefaultPaths*.
#### User home directory location
*String all_homedir_pattern*
@ -37,9 +64,28 @@ Customise the name of the file where ignored users are stored. Default is *ignor
Customise the name of the file where user settings are stored. Default is *linkulatorrc*
### Default User settings
These options can be found in *config.py* in the class *DefaultUser*
To change the default settings for users of the system, amend the following options found in *config.py* in the class *DefaultUser*
#### Default browser
*String browser*
Customise the command used to execute the default browser used by linkulator. Default is *lynx*
### User settings
Users can select their preferred browser by changing the browser setting in their settings file (default is $HOME/.linkulator/linkulatorrc).
For example, to change from lynx to w3m:
```
[User Settings]
browser = w3m
```
## Contributing
Issues, questions and requests for new features can be reported using the [tildegit issues system](https://tildegit.org/cmccabe/linkulator2/issues).
## License
This software is licensed using GPLv3 - see [LICENSE] for more information.