2
0
mirror of https://github.com/carlostrub/sisyphus synced 2024-10-31 09:20:15 +00:00
sisyphus/docs/index.rst
2017-03-16 20:58:24 +00:00

49 lines
1.0 KiB
ReStructuredText

========
Sisyphus
========
Sisyphus is a modern, fully automized junk mail handler. It requires no
configuration and no user interaction to improve the accuracy of its learning
algorithm.
Features
--------
- no configuration required
- no user interaction
- real-time filtering and learning
- handles multiple mail directories
- compatible with Maildir
- daemonized
Installation
------------
- Installation from binary:
1. download the sisyphus binary for your operating system
2. place the binary in your path
3. run sisyphus
- Installation from source:
1. Clone git repository
2. Install glide
3. Run: glide install
4. Run: go install
Contribute
----------
- Issue Tracker: https://github.com/carlostrub/sisyphus/issus
- Source Code: https://github.com/carlostrub/sisyphus
Support
-------
If you are having issues, please let me know via issue tracker.
License
-------
Copyright 2017, Carlo Strub <cs@carlostrub.ch>
This project is licensed under a 3-clause BSD license. See the LICENSE file for
details.