Merge pull request #2 from HideyoshiNakazone/implements-better-readme

Implementing Better README

README.md

@@ -1,16 +1,42 @@
 # CrystalPol
 
-## Arquivo de Configuração - config.yml
+## Arquivo de Configuração - **config.yml**
 
-### No arquivo de Configuração teremos as sequintes keywords:
+No arquivo de Configuração temos as sequintes keywords:
 
-- nprocs
+```yaml
-- mem
+crystal_pol:
-- level
+    mem: *obrigatorio*
-- pop = chelpg
+    level: *obrigatorio*
-- mult = 0 1
+    n_atoms: *obrigatorio*
-- natoms = N
+    n_procs: 1
+    pop: "chelpg"
+    mult: [ 0, 1 ]
+    charge_tolerance: 0.02
+    simulation_dir: "simfiles"
+    comment: "Crystal"
+```
 
-### Teremos um arquivo de entrada crystal.xyz onde ser retirada as moléculas do cristal;
+Estas keywords são utilizadas para controlar o comportamento do programa CrystalPol e de sua dependência Gaussian.
 
-### Os arquivos do gaussian ficarão em um diretório `simfiles` e serão enumerados com o padrão `crystal-00.gjf`
+## Arquivo de input - **crystal.xyz**
+
+O arquivo de input deve ter o formato
+
+```
+H   1.0000  1.0000  1.0000
+```
+Sendo que as primeiras **N** (valor derivado da keyword _**n_atoms**_) átomos devem ser da molécula da celula unitária a ser otimizada. 
+
+Este arquivo pode ser obtido também retirando o header de um arquivo .gjf e o renomeando para .xyz
+
+## Como executar
+
+```bash
+python3 -m crystalpol -c {arquivo_de_config}.yml -i {arquivo_de_input}.xyz -o {arquivo_de_saida}.log
+```
+Caso as opções `-c`, `-i` e `-o` não seja dadas os seguintes valores padrões serão usados:
+
+- arquivo_de_config: `config.yml`
+- arquivo_de_input: `crystal.xyz`
+- arquivo_de_saida: `run.log`