Skip to content

Commit f8b0069

Browse files
committed
update readme
1 parent 4c10f47 commit f8b0069

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,55 @@ As orientações estão divididas nos seguintes tópicos:
6363
## MVC :
6464

6565
O jogo conta com 4 classes principais além da main, a matriz do campo é composta pela classe cell...
66+
6667
![MVCMinesweep](/class_diagram.png)
6768

6869
---
6970
## Strategy :thinking:
71+
Para desenvolver o sistema responsável por salvar o histórico da sessão dos jogadores foi...
7072

7173
---
7274
## Pré-requisitos e configuração :hammer_and_wrench:
7375
No geral, para executar a aplicação é recomendado que o sistema já possua:
76+
- [Python3](https://www.python.org/downloads/);
77+
- Biblioteca Qt5;
78+
- pyInstaller (se desejar gerar um executável para seu sistema);
79+
- [Git](https://git-scm.com/downloads) (opcional caso deseje clonar o repositório);
80+
- [Visual Studio Code](https://code.visualstudio.com/download) (se desejar executar o jogo pelo terminal).
81+
82+
Vale ressaltar que um executável para Windows será disponilibizado na path [Windows](/Windows).
83+
84+
O campo minado foi testado nos seguintes sistemas operacionais (ambientes de desenvolvimento):
85+
- Windows 10;
86+
- Manjaro KDE;
87+
- Ubuntu 18.04 LTS.
88+
89+
### PyQt5
90+
91+
Para instalar a biblioteca em ambos os ambientes supracitados será necessário abrir um terminal (tanto o bash no Visual Studio Code quanto PowerShell no Windows Terminal servirão). Execute o comando abaixo para instalar a biblioteca:
92+
>pip install pyqt5
93+
94+
Para iniciar o jogo pelo terminal deve-se seguir as instruções abaixo.
95+
96+
```bash
97+
98+
# Clone este repositório com
99+
$ git clone https://github.com/MatMB115/minesweeper_mvc_patterns_com221
100+
# ou
101+
$ git clone git@github.com:MatMB115/minesweeper_mvc_patterns_com221.git
102+
103+
# Acesse a pasta do projeto no seu terminal/cmd
104+
$ cd minesweeper_mvc_patterns_com221
105+
106+
# Acesse a pasta do jogo
107+
$ cd minesweeper
108+
109+
# Chame o interpretador do python 3 com o main.py
110+
$ python3 main.py
111+
112+
# O jogo será iniciado corretamente
74113

114+
```
75115

76116
---
77117
## Layout :art:

0 commit comments

Comments
 (0)