diff --git a/docs/MAIN.md b/docs/MAIN.md index 8834c12..a8d0386 100644 --- a/docs/MAIN.md +++ b/docs/MAIN.md @@ -27,3 +27,4 @@ Nyissuk meg a kapott `build` mappát a Visual Studio `Developer Command Prompt`- ```shell script MSBuild p2p.sln ``` + diff --git a/docs/abra/sc2.png b/docs/abra/sc2.png new file mode 100644 index 0000000..1a29323 Binary files /dev/null and b/docs/abra/sc2.png differ diff --git a/docs/abra/sc3.png b/docs/abra/sc3.png new file mode 100644 index 0000000..ee5a656 Binary files /dev/null and b/docs/abra/sc3.png differ diff --git a/docs/user-manual.md b/docs/user-manual.md index 066246c..59f9912 100644 --- a/docs/user-manual.md +++ b/docs/user-manual.md @@ -6,6 +6,7 @@ Ehhez ezeknek a gépeknek az IP címét (IPv4) és a portszámot (amin a program Ha a programot újraindítjuk akkor üzenettel jelzi hogy sikerült-e csatlakozni vagy sem. Például: + ![pelda1](abra/sc1.png) ## Felhasználói felület @@ -14,11 +15,39 @@ A felhasználói felület böngészőből érhető el azon a linken, amit a prog - A `Home` gombra kattintva visszatérhetünk a főoldalra - A `Shutdown` gombra kattintva kiléphetünk a programból -###Felhasználói felület főoldala +### Felhasználói felület főoldala A felület főoldalán a jelenleg csatlakozott peerek, valamint korábbi beszélgető partnerek listáját találjuk.Ha egyik sincs,akkor ezt a program külön üzenettel jelzi. A felhasználó bármely peer nevére rákattintva elérheti az adott peerel kapcsolatos üzenet oldalát. Ha bármi változás történik ezekkel az adatokkal kapcsolatban,akkor az oldal automatikusan frissül. -###Üzenet oldal -Itt a felhasználó elolvashatja a korábbi üzeneteit,valamint ha a peer elérhető akkor üzenet is innen küldhető (Valójában nem a böngésző küldi el az üzenetet.Az csak továbbítja a programnak, ami elküldi a címzettnek). - +![Főoldal](abra/sc3.png) + +### Üzenet oldal +Itt a felhasználó elolvashatja a korábbi üzeneteit,valamint ha a peer elérhető akkor üzenet is innen küldhető (Valójában nem a böngésző küldi el az üzenetet.Az csak továbbítja a programnak, ami elküldi a címzettnek). + +![üzenet oldal](abra/sc2.png) + +## Konfiguráció +A program a `config.ini` fájlban tárolja a beállításait. + +### Elérhető konfigurációs lehetőségek + +- `nickname` - Becenév;az azonosító mellett ez is megjelenik. +- `port` - Az a portszám, amin szeretnénk hogy a program fusson.Ennek a portnak a kinyitása erősen ajánlott a program működéséhez.(Alapértelmezett: `6327`) +- `interface-port` - Az a portszám,amin a felhasználói felület futni fog.Kinyitása nem szükséges (Alapértelmezett: `5081`) +- `interface-folder` - Az a mappa ahol a felhasználói felölethez szükséges fájlok vannak tárolva.(Alapértelmezett: `htdocs/`) +- `interface-local` - Ha az értéke `true`, akkor a felhasználói felület csak a programot futtató gépen érhető el.Használata ajánlott.(Alapértelmezett: `true`) + +### Példa konfiguráció +```ini +#Becenév +#nickname=Pelda +#A program által használt port (Alapértelmezett: 6327) +port=6327 +#Ezne a porton lesz elérhető a felhasználói felület (Alapértelmezett: 5081) +interface-port=5081 +#Ebben a mappában vannak tárolva a html fájlok a felhasználói felülethez (Alapértelmezett: htdocs/) +interface-folder=htdocs/ +#A felhasználói felület csak ezen a gépen érhető elő (Alapértelmezett: true;Ajánlott) +interface-local=true +``` \ No newline at end of file diff --git a/htdocs/header.html b/htdocs/header.html index 6e36e4a..ae3ef5c 100644 --- a/htdocs/header.html +++ b/htdocs/header.html @@ -17,7 +17,7 @@