From 734a34f0e6ce47af49b67919262fb7110b5f6097 Mon Sep 17 00:00:00 2001
From: MAY <may@may.si>
Date: Tue, 17 Jan 2023 11:12:19 +0100
Subject: [PATCH] Dodelan readme z opisom 1KA-F2F

---
 .gitignore |  3 +++
 readme.md  | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 71 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 256f2970d..b7199b1eb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -53,3 +53,6 @@ main/survey/skins/1045_test.css
 
 /d
 /nbproject
+
+.scannerwork/
+.gitignore
diff --git a/readme.md b/readme.md
index 7e36d64ee..afaadd75d 100644
--- a/readme.md
+++ b/readme.md
@@ -1,7 +1,73 @@
-# 1KA - ENKLIK ANKETA
+# 1KA-F2F
+
+1KA (https://www.1ka.si) je spletno orodje za spletno in deloma telefonsko anketiranje.  
+  
+**1KA-F2F** (delovno ime 2KA) je odvejitev (fork) orodja 1KA, ki je prirejena za **profesionalno agencijsko rabo**.  
+
+Odvejitev je bila izpeljana v letu 2017:
+- v letu 2019, 2021 in 2023 je so bile novosti iz 1KA prenešene v 1KA-F2F
+- z letom 2023 (januar) sta zaradi novih 1KA-F2F dodelav postali veji tako različni, da bo z zagotavljanjem združljivosti preveč dela.
+
+## Zakaj 1KA-F2F
+
+Na delu na Centru za merjenje javnega mnenja in množičnih komunikacij (CJMMK) redno izvajamo terenske (F2F), spletne in poštne ankete. Ker so komercialna orodja draga in toga, smo začeli iskati alternativne rešitve in se odločili za 1KA, ki je v dobršni meri pokrila potrebe profesionalnega anketarskega dela.  
+
+Pri prvi resnejši uporabi 1KAe za "push2web" se je izkazala vrsta pomanjkljivosti v zvezi z email obveščanjem in sinhronizacijo podatkov med spletom in papirjem. Od leta 2015 sem vzdrževal seznam sprememb, ki jih je bilo treba dodati k izvirni veji 1KAe. Vseh sprememb ni bilo možno integrirati v izvorno 1KO, saj bi v negativnem smislu vplivale na delovanje obstoječih anket.
+
+Leta 2017 sem razvil tudi funkcionalnosti terenskega anketiranja, ki sem jih leta 2019 temeljito dodelal v skupek orodij, ki so omogočala sočasno anketiranje prek vseh štirih (telefon, splet, poštno, osebno) načinov in sinhronizacijo v skupno podatkovno datoteko.  
+
+V letu 2019 so postale razlike med vejama tako velike, da je bilo nesmiselno vztrajati pri ročnem lepljenju obližov (angl. patchanju) izvorne 1KAe. Tako sem oddvojil vejo 1KA-F2F, ki za razliko od izvirne 1KA nudi nekaj dodatnih funkcionalnosti ter deluje predvidljivo glede na predhodne različice; ne vključuje pa več zadnjih lepotnih popravkov. 
 
 
-## Composer
+## Ključne razlike od osnovne veje
+
+- dodane funkcionalnosti za F2F anketiranje znotraj orodja:
+  - spremenjeno obnašanje piškotov
+  - spremenjeno obnašanje naknadnega urejanja
+  - dodelano izvažanje podatkov (možnost sinhronizacije na centralni strežnik)
+- dopolnjeno pošiljanje obvestilnih pisem (primerno za anketiranje tisočev respondentov)
+- izdelane dodatne skripte za sinhronizacijo in združevanje podatkov na strežnik- spremembe v obnašanju piškotov: 
+- na strežniku samodejna izdelava .SAV datotek iz izvoznh paketov posameznih anketarskih terminalov
+- odstranjen Drupal
+- temeljito očiščena in varnostno dodelana koda (sonarCube ocena kode in varnosti: A/A/A/A. 1KA ima E/E/E/A in 2700 dni programerskega "dolga")
+- vse spremembe ohranjajo združljivost za nazaj
+
+## Ali lahko uporabljam 1KA-F2F?
+
+Programska oprema je izdana pod licenco GNU GPL V2, zato jo lahko uporabljate in dodelujete pod pogoji GNU GPL V2 licence (gl. spodaj).  
+
+Omeniti velja, da je bila 1KA-F2F je bila razvita kot hobi projekt.  
+Podpore tako ne morem nuditi; prav tako ne nudim gostovanja.
+
+
+
+## Avtor
+
+May Doušak; may.dousak@fdv.uni-lj.si
+
+## Licenca 
+
+Programska oprema je prosto na voljo komurkoli pod pogoji licence GNU GPL V2.
+
+
+Copyright (C) May Doušak
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+
+## Navodila composer
 
 ### Dodajanje novega razreda
 V kolikor se doda nov razred v main/survey/app, aplikacija 1ka sama naloži omenej razred zaradi PSR-4 standarda. Pri definiranju novega razreda uporabiti namespace "App\Controller" in deklarirati razred (use ime razreda), katere se uporablja v omenjenem novem razredu.