README atualizado

README.md

@@ -10,3 +10,91 @@
 > Data: 2022-07-01
 
 
+## Descrição
+
+Plugin WordPress que exibe, através do shortcode `[simulador_mob]`, uma
+calculadora de pré-seleção para a mobilidade OUT da ARI/POLI-UPE. Os pesos e
+critérios seguem o Formulário de Mobilidade OUT da ARI/POLI, disponível em
+https://ari.poli.br/document/form-mob-out/.
+
+O estudante escolhe o programa/universidade de destino e o formulário ajusta os
+pesos, os rótulos e as etapas classificatórias de acordo com a opção escolhida.
+
+### POLITO (Politecnico di Torino)
+
+- Usa a Fórmula Padrão V2 da ARI/POLI.
+- Único programa com escolha de Tipo de mobilidade: Mobilidade Simples ou Dupla
+  Diplomação.
+- Proficiência exigida (classificatório):
+  - Mobilidade Simples: Inglês B2 ou Italiano B1.
+  - Dupla Diplomação: Inglês B2.
+  - Quem não comprovar a proficiência mínima é desclassificado.
+- Nota final: H = (O*5 + S*2 + Y*3 + A*2) / (5+2+3+2)
+  - O = nota do histórico (peso 5)
+  - S = nota de atividades (peso 2)
+  - Y = nota de publicações (peso 3)
+  - A = nota de eventos científicos (peso 2)
+
+### FEUP (Faculdade de Engenharia da Universidade do Porto)
+
+- Usa a Fórmula Padrão V2, igual à POLITO.
+- Não possui escolha de tipo de mobilidade nem etapa de proficiência
+  classificatória no simulador.
+- Mesma nota final da Fórmula Padrão V2.
+
+### UCoimbra (Universidade de Coimbra)
+
+- Idêntica à FEUP: Fórmula Padrão V2, sem tipo de mobilidade e sem proficiência.
+- Mesma nota final da Fórmula Padrão V2.
+
+### BRAFITEC (CAPES)
+
+- Usa a Fórmula do BRAFITEC/CAPES, com pesos próprios.
+- Critérios classificatórios (desclassificam o candidato):
+  - Francês abaixo de B1.
+  - Não estar entre 40% e 80% do curso.
+  - Possuir reprovação não recuperada.
+  - Possuir mais de 2 reprovações recuperadas.
+- Nota final: H = (O*7 + E*0,5 + I*1,5 + S*1) / (7+0,5+1,5+1)
+  - O = média curricular (peso 7)
+  - E = experiência em estágio no exterior (peso 0,5)
+  - I = iniciação científica (peso 1,5)
+  - S = outros: monitoria, estágio, extensão, publicações, etc. (peso 1)
+
+Observação: na Fórmula Padrão V2 o critério de porcentagem é estar entre 50% e
+80% do curso; no BRAFITEC o intervalo é de 40% a 80%.
+
+
+## Uso
+
+- Insira o shortcode `[simulador_mob]` em qualquer página ou post. A calculadora
+  aparece no lugar do shortcode.
+- O cálculo é feito no servidor (PHP): o estudante preenche o formulário, clica
+  em "Calcular nota" e o resultado aparece no topo da calculadora.
+- As fórmulas matemáticas são renderizadas com MathJax (carregado via CDN).
+- Ao trocar o programa de destino, o formulário recarrega automaticamente para
+  ajustar pesos, rótulos e a etapa de proficiência.
+
+
+## Instalação e atualização
+
+### Instalação
+
+1. Copie a pasta `simulador-mob-out-ari-poli` para o diretório
+   `wp-content/plugins/` do site.
+2. No painel do WordPress, em Plugins, ative "Simulador Mob-Out ARI-POLI".
+3. Edite a página desejada e insira o shortcode `[simulador_mob]`.
+
+### Atualização (modo atual)
+
+O plugin não está no diretório do WordPress.org, portanto não há atualização
+automática. O modo atual de atualização é reinstalar copiando os arquivos:
+
+1. Obtenha a nova versão do repositório (git pull ou download).
+2. Substitua os arquivos em
+   `wp-content/plugins/simulador-mob-out-ari-poli/` pelos novos, sobrescrevendo.
+3. Não é necessário desativar o plugin: a configuração fica na página (o
+   shortcode), e não no banco de dados.
+
+Um plano (ainda não implementado) para atualização automática a partir do
+repositório Gitea está descrito em PLAN-FOR-AUTO-UPDATE.md.