Update documentation

davidsonbrsilva · May 25, 2019 · 8f88100 · 8f88100
1 parent 4a27343
commit 8f88100
Show file tree

Hide file tree

Showing 3 changed files with 161 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -1,62 +1,65 @@
 # Hufzip
-![Project Status](https://img.shields.io/badge/status-stopped-red.svg?style=popout-square)  
+![Project Status](https://img.shields.io/badge/status-stopped-red.svg?style=popout-square)
 
-**Hufzip** é um compressor de arquivos de texto baseado no algoritmo de Huffman. Possui caráter didático e foi construído com o único propósito de aprendizado sobre métodos de compressão de arquivos. Arquivos comprimidos com Hufzip possuem a extensão `.hfz`.
+[[Ver em Português](docs/pt-br/README.md)]
 
-## <a name="qg"></a>Guia rápido
+**Hufzip** is a text file compressor based on Huffman algorithm. It has a didatic character and was built for the sole purpose of learning about file compressing methods. Files compressed with Huffzip have `.hfz` extension.
 
-Este é um guia rápido de como executar Hufzip no Repl<span>.</span>it.
+## Quick Guide
 
-### <a name="qg-compressing"></a>Compactando um arquivo
+This is a quick guild to how to run Hufzip on Repl<span>.</span>it.
 
-1. Acesse o [repl do projeto](https://repl.it/@davidsonbrsilva/hufzip);
-2. Com o editor de código em foco, pressione `Ctrl` + `Shift` + `P` no Windows e no Linux ou com `Cmd` + `Shift` + `P` no Mac. Uma caixa de texto deve abrir;
-3. Pesquise por "Open Shell" e clique na opção que aparecer. Um terminal deve abrir no canto inferior direito;
-4. Digite o seguinte comando no terminal:
+### Compressing a file
+
+1. Open the [project repl](https://repl.it/@davidsonbrsilva/hufzip);
+2. With the editor on focus, press `Ctrl` + `Shift` + `P` on Windows and Linux or `Cmd` + `Shift` + `P` on Mac. A text box should open;
+3. Search "Open Shell" and click the option that appears.
+4. Type the following command on terminal:
 ```
 $ ./main -c "sample/long.txt"
 ```
-Pronto! Se ocorreu tudo bem, um arquivo `long.hfz` foi criado na pasta `sample`.
+Done! If everything went well, a `long.hfz` file was created on `sample` folder.
+
+### Decompressing a file
 
-### <a name="qg-decompressing"></a>Descompactando um arquivo
 
-1. Acesse o [repl do projeto](https://repl.it/@davidsonbrsilva/hufzip);
-2. Com o editor de código em foco, pressione `Ctrl` + `Shift` + `P` no Windows e no Linux ou com `Cmd` + `Shift` + `P` no Mac. Uma caixa de texto deve abrir;
-3. Pesquise por "Open Shell" e clique na opção que aparecer. Um terminal deve abrir no canto inferior direito;
-4. Digite o seguinte comando no terminal.
+1. Open the [project repl](https://repl.it/@davidsonbrsilva/hufzip);
+2. With the editor on focus, press `Ctrl` + `Shift` + `P` on Windows and Linux or `Cmd` + `Shift` + `P` on Mac. A text box should open;
+3. Search "Open Shell" and click the option that appears.
+4. Type the following command on terminal:
 ```
-$ ./main -d "sample/long.hfz"
+$ ./main -c "sample/long.txt"
 ```
-Tudo certo! Se ocorreu tudo bem, um arquivo `long.txt` foi criado na pasta `sample`.
+All right! If everything went well, a `long.txt` file was created on `sample` folder.
 
-## <a name="bf"></a>Construindo arquivos binários
+## Building
 
-Não foi provido nenhum Makefile para o projeto. Porém, ele pode ser compilado sem maiores complicações. O teste foi realizado com MinGW para Windows 64 bits.
+No makefile was provided for the project. However, it can be built without major complications. The test was performed with MinGW for Windows 64 bits.
 
-## <a name="us"></a>Uso
+## Uso
 
-### <a name="rn-compressing"></a>Compactando arquivo
+### Compressing file
 
-Utilize o parâmetro `-c`, seguido do caminho do arquivo, para compactá-lo. Por exemplo:
+Use parameter `-c` parameter, followed by filepath, to compress it. For instance:
 ```
 $ hufzip -c "sample/long.txt"
 ```
 
-### <a name="rn-decompressing"></a>Descompactando arquivo
+### Decompressing file
 
-Utilize o parâmetro `-d`, seguido do caminho do arquivo, para descompactá-lo. Por exemplo:
+Use parameter `-d` parameter, followed by filepath, to decompress it. For instance:
 ```
 $ hufzip -d "sample/long.hfz"
 ```
 
-## <a name="sp"></a>Suporte
+## Support
 
-Envie e-mail para <davidsonbruno@outlook.com>.
+Send email to <davidsonbruno@outlook.com>.
 
-## <a name="ct"></a>Contribuição
+## Contributing
 
-Por favor, verifique o [Guia de Contribuição](CONTRIBUTING.md).
+Please, check the [Contributing Guide](CONTRIBUTING.md).
 
-## <a name="ls"></a>Licença
+## License
 
 [MIT](LICENSE.md) Copyright (c) 2019, Davidson Bruno.
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -0,0 +1,65 @@
+# Hufzip
+![Project Status](https://img.shields.io/badge/status-stopped-red.svg?style=popout-square)
+
+[[Ver em Português](docs/pt-br/README.md)]
+
+**Hufzip** is a text file compressor based on Huffman algorithm. It has a didatic character and was built for the sole purpose of learning about file compressing methods. Files compressed with Huffzip have `.hfz` extension.
+
+## Quick Guide
+
+This is a quick guild to how to run Hufzip on Repl<span>.</span>it.
+
+### Compressing a file
+
+1. Open the [project repl](https://repl.it/@davidsonbrsilva/hufzip);
+2. With the editor on focus, press `Ctrl` + `Shift` + `P` on Windows and Linux or `Cmd` + `Shift` + `P` on Mac. A text box should open;
+3. Search "Open Shell" and click the option that appears.
+4. Type the following command on terminal:
+```
+$ ./main -c "sample/long.txt"
+```
+Done! If everything went well, a `long.hfz` file was created on `sample` folder.
+
+### Decompressing a file
+
+
+1. Open the [project repl](https://repl.it/@davidsonbrsilva/hufzip);
+2. With the editor on focus, press `Ctrl` + `Shift` + `P` on Windows and Linux or `Cmd` + `Shift` + `P` on Mac. A text box should open;
+3. Search "Open Shell" and click the option that appears.
+4. Type the following command on terminal:
+```
+$ ./main -c "sample/long.txt"
+```
+All right! If everything went well, a `long.txt` file was created on `sample` folder.
+
+## Building
+
+No makefile was provided for the project. However, it can be built without major complications. The test was performed with MinGW for Windows 64 bits.
+
+## Uso
+
+### Compressing file
+
+Use parameter `-c` parameter, followed by filepath, to compress it. For instance:
+```
+$ hufzip -c "sample/long.txt"
+```
+
+### Decompressing file
+
+Use parameter `-d` parameter, followed by filepath, to decompress it. For instance:
+```
+$ hufzip -d "sample/long.hfz"
+```
+
+## Support
+
+Send email to <davidsonbruno@outlook.com>.
+
+## Contributing
+
+Please, check the [Contributing Guide](CONTRIBUTING.md).
+
+## License
+
+[MIT](LICENSE.md) Copyright (c) 2019, Davidson Bruno.
diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md
@@ -0,0 +1,64 @@
+# Hufzip
+![Project Status](https://img.shields.io/badge/status-stopped-red.svg?style=popout-square)
+
+[[See in English](docs/en/README.md)]
+
+**Hufzip** é um compressor de arquivos de texto baseado no algoritmo de Huffman. Possui caráter didático e foi construído com o único propósito de aprendizado sobre métodos de compressão de arquivos. Arquivos comprimidos com Hufzip possuem a extensão `.hfz`.
+
+## Guia rápido
+
+Este é um guia rápido de como executar Hufzip no Repl<span>.</span>it.
+
+### Compactando um arquivo
+
+1. Acesse o [repl do projeto](https://repl.it/@davidsonbrsilva/hufzip);
+2. Com o editor de código em foco, pressione `Ctrl` + `Shift` + `P` no Windows e no Linux ou com `Cmd` + `Shift` + `P` no Mac. Uma caixa de texto deve abrir;
+3. Pesquise por "Open Shell" e clique na opção que aparecer. Um terminal deve abrir no canto inferior direito;
+4. Digite o seguinte comando no terminal:
+```
+$ ./main -c "sample/long.txt"
+```
+Pronto! Se ocorreu tudo bem, um arquivo `long.hfz` foi criado na pasta `sample`.
+
+### Descompactando um arquivo
+
+1. Acesse o [repl do projeto](https://repl.it/@davidsonbrsilva/hufzip);
+2. Com o editor de código em foco, pressione `Ctrl` + `Shift` + `P` no Windows e no Linux ou com `Cmd` + `Shift` + `P` no Mac. Uma caixa de texto deve abrir;
+3. Pesquise por "Open Shell" e clique na opção que aparecer. Um terminal deve abrir no canto inferior direito;
+4. Digite o seguinte comando no terminal.
+```
+$ ./main -d "sample/long.hfz"
+```
+Tudo certo! Se ocorreu tudo bem, um arquivo `long.txt` foi criado na pasta `sample`.
+
+## Construindo arquivos binários
+
+Não foi provido nenhum Makefile para o projeto. Porém, ele pode ser compilado sem maiores complicações. O teste foi realizado com MinGW para Windows 64 bits.
+
+## Uso
+
+### Compactando arquivo
+
+Utilize o parâmetro `-c`, seguido do caminho do arquivo, para compactá-lo. Por exemplo:
+```
+$ hufzip -c "sample/long.txt"
+```
+
+### Descompactando arquivo
+
+Utilize o parâmetro `-d`, seguido do caminho do arquivo, para descompactá-lo. Por exemplo:
+```
+$ hufzip -d "sample/long.hfz"
+```
+
+## Suporte
+
+Envie e-mail para <davidsonbruno@outlook.com>.
+
+## Contribuição
+
+Por favor, verifique o [Guia de Contribuição](CONTRIBUTING.md).
+
+## Licença
+
+[MIT](LICENSE.md) Copyright (c) 2019, Davidson Bruno.