From f25c7b2c86e7958cc403cc1d0d2333c498b31c28 Mon Sep 17 00:00:00 2001 From: Carlo Strub Date: Thu, 16 Mar 2017 20:58:24 +0000 Subject: [PATCH] more docs --- docs/details.rst | 12 ++++++++++++ docs/index.rst | 17 ++++++++++++----- 2 files changed, 24 insertions(+), 5 deletions(-) create mode 100644 docs/details.rst diff --git a/docs/details.rst b/docs/details.rst new file mode 100644 index 0000000..ce66128 --- /dev/null +++ b/docs/details.rst @@ -0,0 +1,12 @@ +====================== +Details about Sisyphus +====================== + +In a nutshell this is what sisyphus is doing after starting it: + +1. Load all mails in the good and junk directories +2. Check for each mail whether it has been processed +3. If not processed, than classify it based on subject and body content +4. If processed, check whether it has not been moved from junk to good or vice versa +5. If a processed mail has been moved to the other folder, unlearn its words from the old one and learn them for the new classification +6. Observe the junk and good mail directory in real time and handle new incoming mails directly diff --git a/docs/index.rst b/docs/index.rst index 99fa77d..a7092cd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,4 @@ +======== Sisyphus ======== @@ -18,15 +19,21 @@ Features Installation ------------ -Install sisyphus by running: - - install project +- 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: github.com/carlostrub/sisyphus/issus -- Source Code: github.com/carlostrub/sisyphus +- Issue Tracker: https://github.com/carlostrub/sisyphus/issus +- Source Code: https://github.com/carlostrub/sisyphus Support -------