Added images to user manual

This commit is contained in:
Bazsalanszky 2019-11-25 22:26:46 +01:00
parent e32bebd648
commit b71c4c7e4a
Signed by: Bazsalanszky
GPG key ID: 3A1E008A6F682DA0
5 changed files with 35 additions and 5 deletions

View file

@ -27,3 +27,4 @@ Nyissuk meg a kapott `build` mappát a Visual Studio `Developer Command Prompt`-
```shell script
MSBuild p2p.sln
```

BIN
docs/abra/sc2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/abra/sc3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View file

@ -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
![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
```

View file

@ -17,7 +17,7 @@
<div
class="collapse navbar-collapse" id="navcol-1">
<ul class="nav navbar-nav">
<li class="nav-item" role="presentation"><a class="nav-link active" href="/">Home</a></li>
<li class="nav-item" role="presentation"><a class="nav-link" href="/">Home</a></li>
<li class="nav-item" role="presentation"></li>
<li class="nav-item" role="presentation"></li>
</ul>