diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 36 insertions, 11 deletions
@@ -1,29 +1,37 @@ pacredir ======== +[](https://github.com/eworm-de/pacredir/stargazers) +[](https://github.com/eworm-de/pacredir/network) +[](https://github.com/eworm-de/pacredir/watchers) + **pacredir - redirect pacman requests, assisted by avahi service discovery** -By default every [Arch Linux](https://www.archlinux.org/) installation +By default every [Arch Linux ↗️](https://www.archlinux.org/) installation downloads its package files from online mirrors, transferring all the bits via WAN connection. But often other Arch systems may be around that already have the files available on local storage - just a fast LAN connection away. This is -where `pacredir` can help. It uses [Avahi](http://avahi.org/) to find +where `pacredir` can help. It uses [Avahi ↗️](https://avahi.org/) to find other instances and get the files there if available. +*Use at your own risk*, pay attention to +[license and warranty](#license-and-warranty), and +[disclaimer on external links](#disclaimer-on-external-links)! + Requirements ------------ To compile and run `pacredir` you need: -* [systemd](https://www.github.com/systemd/systemd) -* [avahi](https://avahi.org/) -* [libmicrohttpd](https://www.gnu.org/software/libmicrohttpd/) -* [curl](https://curl.haxx.se/) -* [iniparser](https://github.com/ndevilla/iniparser) -* [darkhttpd](https://unix4lyfe.org/darkhttpd/) -* [markdown](https://daringfireball.net/projects/markdown/) (HTML documentation) +* [systemd ↗️](https://www.github.com/systemd/systemd) +* [avahi ↗️](https://avahi.org/) +* [libmicrohttpd ↗️](https://www.gnu.org/software/libmicrohttpd/) +* [curl ↗️](https://curl.haxx.se/) +* [iniparser ↗️](https://github.com/ndevilla/iniparser) +* [darkhttpd ↗️](https://unix4lyfe.org/darkhttpd/) +* [markdown ↗️](https://daringfireball.net/projects/markdown/) (HTML documentation) `Arch Linux` installs development files for the packages by default, so no additional development packages are required. @@ -42,8 +50,7 @@ followed by: This will place an executable at `/usr/bin/pacredir`, documentation can be found in `/usr/share/doc/pacredir/`. Additionally systemd service files are installed to -`/usr/lib/systemd/system/` and avahi service files go to -`/etc/avahi/services/`. +`/usr/lib/systemd/system/`. Usage ----- @@ -98,6 +105,21 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](COPYING.md) for more details. +Disclaimer on external links +---------------------------- + +Our website contains links to the websites of third parties ("external +links"). As the content of these websites is not under our control, we +cannot assume any liability for such external content. In all cases, the +provider of information of the linked websites is liable for the content +and accuracy of the information provided. At the point in time when the +links were placed, no infringements of the law were recognisable to us. +As soon as an infringement of the law becomes known to us, we will +immediately remove the link in question. + +> 💡️ **Hint**: All external links are marked with an arrow pointing +> diagonally in an up-right (or north-east) direction (↗️). + ### Upstream URL: @@ -106,3 +128,6 @@ URL: Mirror: [eworm.de](https://git.eworm.de/cgit.cgi/pacredir/about/) [GitLab.com](https://gitlab.com/eworm-de/pacredir#pacredir) + +--- +[⬆️ Go back to top](#top) |