From 433dd1b1b35f3d1665689e197d2474f5c4e7f4a1 Mon Sep 17 00:00:00 2001 From: Bomrafinha <31997765+bomrafinha@users.noreply.github.com> Date: Fri, 6 Mar 2020 13:50:10 -0300 Subject: [PATCH] Readme + Estrutura das pastas --- README.md | 221 ++++++++++++++++++- app/.gitkeep | 0 documentation/configuracaoFonte.md | 0 documentation/documentacao.md | 0 documentation/images/sitemap - Copia (2).png | Bin 0 -> 1542 bytes documentation/images/sitemap.png | Bin 0 -> 1542 bytes documentation/images/workgroup.png | Bin 0 -> 1542 bytes documentation/usage/uso.png | Bin 0 -> 1151 bytes images/.gitkeep | 0 output/.gitkeep | 0 vendor/.gitkeep | 0 11 files changed, 219 insertions(+), 2 deletions(-) create mode 100644 app/.gitkeep create mode 100644 documentation/configuracaoFonte.md create mode 100644 documentation/documentacao.md create mode 100644 documentation/images/sitemap - Copia (2).png create mode 100644 documentation/images/sitemap.png create mode 100644 documentation/images/workgroup.png create mode 100644 documentation/usage/uso.png create mode 100644 images/.gitkeep create mode 100644 output/.gitkeep create mode 100644 vendor/.gitkeep diff --git a/README.md b/README.md index 7bc7271..dd9c5b0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,219 @@ -# Conversor-XML-JSON - Conversor de XML para Json e vice-versa +# Format Converter ![](https://img.shields.io/badge/Build-1.0.0.0-brightgreen) ![Maintenance](https://img.shields.io/maintenance/yes/2020) +>Conversor de formatos (JSON, XML, etc) + +
+ +******* +## Índice + 1. [Uso](#uso) + 2. [Estrutura](#estrutura) + 3. [Workgroup](#workgroup) + 4. [Dependências](#dependencias) + 5. [Instalação/Configuração](#instalacao) + 6. [Contribuir](#contribuir) + 7. [Créditos](#creditos) + 8. [Licença](#licenca) + 9. [Documentação](#documentacao) + 10. [TODO](#todo) + 11. [Árvore do Projeto](#arvore) +******* + +
+ +## Uso +Implementar as **[formas de uso](documentation/usage)**. + +![Uso](documentation/usage/uso.png) + +
+ ++ **PACKAGE** + - **CLASS** + * **METHOD:** Descrição do Método + + **Parametrização** + - *var01*: Variável 01; + - *var02*: Variável 02; + +![Sitemap](documentation/images/sitemap.png) + +
+ +## Estrutura ++ **app:** Contém a compilação do(s) pacote(s) e testador(es); ++ **documentation:** Contém a documentação do(s) pacote(s); ++ **images:** Contém as imagens usadas no(s) pacote(s); ++ **modules:** Módulos não essenciais, como testadores, etc; + - **testador tal:** Implementar; ++ **output:** Contém os arquivos précompilados usados pelo Delphi (.dcu); ++ **project:** Diretório com os projetos de cada pacote e testador; ++ **src:** Contém o fonte essencial para o funcionamento do(s) pacote(s); + - **pacote tal:** Pacote centralizador do sistema, quando o executável faz a chamada da função solicitada é essa parte da aplicação que localiza as rotinas nos pacotes; ++ **vendor:** Contém os pacotes de terceiros; + +
+ +## Workgroup +Deve-se manter a ordem de compilação do projeto exatamente como na imagem. + +![Workgroup](documentation/images/workgroup.png) + +
+ +## Dependências ++ **Dependência01:** Dependência; + +
+ +## Instalação/Configuração ++ **[Configuração](documentation/configuracaoFonte.md)** + +
+ +## Contribuir +1. Faça um "fork" com base no master; +2. Faça "commit" de suas alterações (Caso estiver resolvento alguma "issue" não esqueça de na mensagem escrever "Fixed #numeroIssue"); +3. Faça "push" de seus commits; +4. Solicite um "pull request" para o master do repositório principal. + +
+ +## Créditos +[@bomrafinha](https://github.com/bomrafinha) + +
+ +## [Licença](./LICENSE) +Verificar tipo de licença. ++ Propriedade Intelectual: [@bomrafinha](https://github.com/bomrafinha) + +
+ +## Documentação ++ **[Implementar documentação](documentation/documentacao.md)** + +
+ +## TODO ++ Documentação + - README + - LICENCE + - usage + - sitemap + - workgroup + - configuração do fonte + - arquivo padronização de código e documentação + - forma de versionamento + - shields + - especificar linguagem padrão + ++ Estrutura básica do código + - Criação da forma que ficarão os pacotes + - Pacotes com recursos visuais (arrastar e soltar) + - Criação dos testadores + - Configurações de path e versionamento + ++ Conversor JSON -> XML + - Entrada JSON -> Saída XML + - Entrada JSON -> Saída string + - Entrada JSON -> Saída arquivo + - Entrada string -> Saída XML + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída XML + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + ++ Conversor JSON -> CSV + - Entrada JSON -> Saída CSV + - Entrada JSON -> Saída string + - Entrada JSON -> Saída arquivo + - Entrada string -> Saída CSV + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída CSV + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + ++ Conversor XML -> JSON + - Entrada XML -> Saída JSON + - Entrada XML -> Saída string + - Entrada XML -> Saída arquivo + - Entrada string -> Saída JSON + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída JSON + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + ++ Conversor XML -> CSV + - Entrada XML -> Saída CSV + - Entrada XML -> Saída string + - Entrada XML -> Saída arquivo + - Entrada string -> Saída CSV + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída CSV + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + ++ Conversor CSV -> JSON + - Entrada CSV -> Saída JSON + - Entrada CSV -> Saída string + - Entrada CSV -> Saída arquivo + - Entrada string -> Saída JSON + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída JSON + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + ++ Conversor CSV -> XML + - Entrada CSV -> Saída XML + - Entrada CSV -> Saída string + - Entrada CSV -> Saída arquivo + - Entrada string -> Saída XML + - Entrada string -> Saída string + - Entrada string -> Saída arquivo + - Entrada arquivo -> Saída XML + - Entrada arquivo -> Saída string + - Entrada arquivo -> Saída arquivo + +
+ +## Árvore do Projeto +``` +FormatConversor +├── app +│ └── .gitkeep +├── documentation +│ ├── images +│ │ ├── sitemap - Copia (2).png +│ │ ├── sitemap.png +│ │ └── workgroup.png +│ ├── usage +│ │ └── uso.png +│ ├── configuracaoFonte.md +│ └── documentacao.md +├── images +│ └── .gitkeep +├── modules +│ ├── U_Testador.View.fmx +│ └── U_Testador.View.pas +├── output +│ └── .gitkeep +├── project +│ ├── Delphi XMLtoJSON.groupproj +│ ├── Testador.dpr +│ ├── Testador.dproj +│ ├── XMLtoJSON.dpk +│ └── XMLtoJSON.dproj +├── src +│ └── XMLtoJSON +│ └── U_XMLtoJSON.pas +├── vendor +│ └── .gitkeep +├── .gitattributes +├── .gitignore +├── LICENSE +└── README.md +``` \ No newline at end of file diff --git a/app/.gitkeep b/app/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/documentation/configuracaoFonte.md b/documentation/configuracaoFonte.md new file mode 100644 index 0000000..e69de29 diff --git a/documentation/documentacao.md b/documentation/documentacao.md new file mode 100644 index 0000000..e69de29 diff --git a/documentation/images/sitemap - Copia (2).png b/documentation/images/sitemap - Copia (2).png new file mode 100644 index 0000000000000000000000000000000000000000..ab80cb573536dd55cf4bb22d1cf0b678fedc70f0 GIT binary patch literal 1542 zcmeAS@N?(olHy`uVBq!ia0y~yV7vlkf97BVlJ-BJhXE5jgR z3=A9lx&I`x0{NT;9+AZi419+{nDKc2iWCM0*4dsejv*CsZ*Lp+UGb1;2-G`aYr*3F zfF-73&YT%jrc9X7BmL#v`b_TCGv+RvzP{S_h3&~hsk={2oAAfi|L|&Ih7ZSCL>ZWx zxEL56SsNM_FgZ8`Fe)glU=R=pVc_7393lg52OPiY)Ml@SZoY7G8`&+Ti?_?#T#+zq;T5hx7-+yb@zc=Si zqf653A8pzB?ce_0_x7Kae{Fp3=TF5%-$oU*P-m z=XdJ%?E3ca`Z}=6&nwISXTL5zS7m#kQ8(WvFRl0R(vQJ~GgsvP&qz<&QrEt7zWu?u z+1uWmgkQh+|JK)QKa=OxU%R=Ff9^-IE0$*WSH63`CYwp-#;0SC)2>;>NUe9A^|$ll zzxb!`)_y+zO|$G=?(MX_b+YTf%U@sf{mP%WH`W;LtEueyA~So&x&MK+dA<$I(f2B3 zrtM&mnYCb_NE255jgR z3=A9lx&I`x0{NT;9+AZi419+{nDKc2iWCM0*4dsejv*CsZ*Lp+UGb1;2-G`aYr*3F zfF-73&YT%jrc9X7BmL#v`b_TCGv+RvzP{S_h3&~hsk={2oAAfi|L|&Ih7ZSCL>ZWx zxEL56SsNM_FgZ8`Fe)glU=R=pVc_7393lg52OPiY)Ml@SZoY7G8`&+Ti?_?#T#+zq;T5hx7-+yb@zc=Si zqf653A8pzB?ce_0_x7Kae{Fp3=TF5%-$oU*P-m z=XdJ%?E3ca`Z}=6&nwISXTL5zS7m#kQ8(WvFRl0R(vQJ~GgsvP&qz<&QrEt7zWu?u z+1uWmgkQh+|JK)QKa=OxU%R=Ff9^-IE0$*WSH63`CYwp-#;0SC)2>;>NUe9A^|$ll zzxb!`)_y+zO|$G=?(MX_b+YTf%U@sf{mP%WH`W;LtEueyA~So&x&MK+dA<$I(f2B3 zrtM&mnYCb_NE255jgR z3=A9lx&I`x0{NT;9+AZi419+{nDKc2iWCM0*4dsejv*CsZ*Lp+UGb1;2-G`aYr*3F zfF-73&YT%jrc9X7BmL#v`b_TCGv+RvzP{S_h3&~hsk={2oAAfi|L|&Ih7ZSCL>ZWx zxEL56SsNM_FgZ8`Fe)glU=R=pVc_7393lg52OPiY)Ml@SZoY7G8`&+Ti?_?#T#+zq;T5hx7-+yb@zc=Si zqf653A8pzB?ce_0_x7Kae{Fp3=TF5%-$oU*P-m z=XdJ%?E3ca`Z}=6&nwISXTL5zS7m#kQ8(WvFRl0R(vQJ~GgsvP&qz<&QrEt7zWu?u z+1uWmgkQh+|JK)QKa=OxU%R=Ff9^-IE0$*WSH63`CYwp-#;0SC)2>;>NUe9A^|$ll zzxb!`)_y+zO|$G=?(MX_b+YTf%U@sf{mP%WH`W;LtEueyA~So&x&MK+dA<$I(f2B3 zrtM&mnYCb_NE25C6Kv%hU7wI2WG6SU@j%GrIp7$zwEU=VEL7f>8# z)cMnKwtqWnewD~Fq^tc%|GvFh=f{Wh0)I9O|9SrX$Is8D41f9_%%A&U{$txi{~I36 zzbm&}vi?uS&OO!N_t^jc_v2&npJ!*Ee){|S>m&8zH?Ob9uaAFrL+*0q|F5r~7r(zB z&mVVoqkCMv&8B;6zt`V6HfMh6wT;{J>*s!cc=&VF=UoDYdz~%Tc3zkJ(|LpC-Ry zd9(K)e>`OSzhn9QD!<(RyFJgPKW^%Oe#>&(pOZfy{}Mj;xT4lN{@d4gYyZEf`u)f7 z@nfmowdeM!x#X1dE#G|n-Mt@Sf8;FfAJ^Vy-Wy+^|F^a}b8qdx8|!b%zg&}hbA5Zq z;n)M3Z$IubpZ9nAqw?3%-#-4CW8GH{bj#w`Z$BTeJNxHaL5f&pj;pR&iJQ ze%F1M^1sWU9Vx1BtD9pl&ry7~YT3T(FJI+j^XJ*L)@DI;#*j%@7vGhzhVZ@uWfsC{r%&=Uym!lzB_Aw-&v{0r>8&XpJ-{easK{` z^_jjMH{Qt<9pN`(+3)v3(fPw`7I`BUc?G8rj7p;vp&)oz^pij6{`p=mxo?udLW9B6 L)z4*}Q$iB}eg56x literal 0 HcmV?d00001 diff --git a/images/.gitkeep b/images/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/output/.gitkeep b/output/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/vendor/.gitkeep b/vendor/.gitkeep new file mode 100644 index 0000000..e69de29