README: add more information
This commit is contained in:
32
README.md
32
README.md
@ -2,11 +2,29 @@
|
|||||||
|
|
||||||
EDB-system for PVVVV
|
EDB-system for PVVVV
|
||||||
|
|
||||||
|
## Hva er dette?
|
||||||
|
|
||||||
|
Dibbler er et system laget av PVVere for PVVere for å byttelåne både matvarer og godis.
|
||||||
|
Det er designet for en gammeldags VT terminal, og er laget for å være enkelt både å bruke og å hacke på.
|
||||||
|
|
||||||
|
Programmet er skrevet i Python, og bruker en sql database for å lagre data.
|
||||||
|
|
||||||
|
Samlespleiseboden er satt opp slik at folk kjøper inn varer, og får dibblerkreditt, og så kan man bruke
|
||||||
|
denne kreditten til å kjøpe ut andre varer. Det er ikke noen form for authentisering, så hele systemet er basert på tillit.
|
||||||
|
Det er anbefalt å koble en barkodeleser til systemet for å gjøre det enklere å både legge til og kjøpe varer.
|
||||||
|
|
||||||
|
## Kom i gang
|
||||||
|
|
||||||
|
Installer python, og lag og aktiver et venv. Installer så avhengighetene med `pip install`.
|
||||||
|
|
||||||
|
Deretter kan du kjøre programmet med
|
||||||
|
|
||||||
|
```console
|
||||||
|
python -m dibbler -c example-config.ini create-db
|
||||||
|
python -m dibbler -c example-config.ini loop
|
||||||
|
```
|
||||||
|
|
||||||
## Nix
|
## Nix
|
||||||
### Hvordan kjøre
|
|
||||||
|
|
||||||
`nix run github:Prograrmvarverkstedet/dibbler`
|
|
||||||
|
|
||||||
|
|
||||||
### Bygge nytt image
|
### Bygge nytt image
|
||||||
|
|
||||||
@ -16,11 +34,11 @@ For å bygge et image trenger du en builder som takler å bygge for arkitekturen
|
|||||||
|
|
||||||
Flaket exposer en modul som autologger inn med en bruker som automatisk kjører dibbler, og setter opp et minimalistisk miljø.
|
Flaket exposer en modul som autologger inn med en bruker som automatisk kjører dibbler, og setter opp et minimalistisk miljø.
|
||||||
|
|
||||||
Før du bygger imaget burde du endre conf.py lokalt til å inneholde instillingene dine. **NB: Denne kommer til å ligge i nix storen.**
|
Før du bygger imaget burde du endre `conf.py` lokalt til å inneholde instillingene dine. **NB: Denne kommer til å ligge i nix storen, ikke si noe her som du ikke vil at moren din skal høre.**
|
||||||
|
|
||||||
Du kan også endre hvilken conf.py som blir brukt direkte i pakken eller i modulen.
|
Du kan også endre hvilken `conf.py` som blir brukt direkte i pakken eller i modulen.
|
||||||
|
|
||||||
Se eksempelet for hvordan skrot er satt opp i flake.nix
|
Se eksempelet for hvordan skrot er satt opp i `flake.nix` og `nix/skrott.nix`
|
||||||
|
|
||||||
### Bygge image for skrot
|
### Bygge image for skrot
|
||||||
Skrot har et image definert i flake.nix:
|
Skrot har et image definert i flake.nix:
|
||||||
|
Reference in New Issue
Block a user