diff --git a/README.md b/README.md index 2a973507..7d62383f 100755 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -**Biblioteca em C# para emissão e impressão de NFe, NFCe, MDF-e e CT-e** +# ZeusFiscal +### A Principal Biblioteca em C# para Emissão e Impressão de NFe, NFCe, MDF-e e CT-e +**![Fork e Continuação do DFe.NET ("Zeus") - SAIBA MAIS SOBRE A DECLARAÇÃO DOS MANTENEDORES NESSE LINK!](https://google.com.br)** -DFe.NET -================== +**Entre no nosso **Discord** https://discord.gg/EE4TGKAkkG** -Biblioteca gratuita para Geração de NFe 3.10/4.00, NFCe 3.10/4.00, MDF-e 3.0 e CT-e 3.0/4.0 e consumo dos serviços necessários à sua manutenção, conforme descritos em http://www.nfe.fazenda.gov.br/portal/principal.aspx, https://mdfe-portal.sefaz.rs.gov.br e www.cte.fazenda.gov.br/portal. +## Versões suportadas: A biblioteca foi desenvolvida em **C#** utilizando Visual Studio Community 2022 com os SDKs net462, netstandard2.0 e net6.0 instalados. - -**Versões suportadas:** | Escopos | Frameworks Suportados | | ------------------- | ------------------- | | NFe, NFCe, CTe, MDFe | .NET 4.6.2, .NET 4.7, .NET 4.7.1, .NET 4.7.2, .NET 4.8, .NetStandard 2.0, .NET 6.0 .NET 7.0 .NET 8.0 | @@ -19,30 +18,28 @@ A biblioteca foi desenvolvida em **C#** utilizando Visual Studio Community 2022 Licenciada sobre a **LGPL** (https://pt.wikipedia.org/wiki/GNU_Lesser_General_Public_License). -Entre no nosso **Discord** -> https://discord.gg/EE4TGKAkkG no grupo falaremos não somente do Zeus.NET, mas também de varios outros frameworks que são criados no dia-a-dia. +## Pacotes Nugets: -**Pacotes Nugets:** ------------------- -A melhor maneira de você ter a última versão do Zeus em seu projeto é utilizando os pacotes Nugets abaixo +A melhor maneira de você ter a última versão do ZeusFiscal em seu projeto é utilizando os pacotes Nugets abaixo -[![Build status](https://github.com/ZeusAutomacao/DFe.NET/actions/workflows/DFe.NET_build.yml/badge.svg?branch=master)](https://github.com/ZeusAutomacao/DFe.NET/actions/workflows/DFe.NET_build.yml) -[![Issues](https://img.shields.io/github/issues/ZeusAutomacao/DFe.NET.svg?style=flat-square)](https://github.com/ZeusAutomacao/DFe.NET/issues) +[![Build status](https://github.com/Hercules-NET/ZeusFiscal/actions/workflows/ZeusFiscal.NET_build.yml/badge.svg?branch=master)](https://github.com/Hercules-NET/ZeusFiscal/actions/workflows/ZeusFiscal_build.yml) +[![Issues](https://img.shields.io/github/issues/Hercules-NET/ZeusFiscal.svg?style=flat-square)](https://github.com/Hercules-NET/ZeusFiscal/issues) -[![Nuget downloads](https://img.shields.io/nuget/dt/Zeus.Net.NFe.NFCe.svg)](http://www.nuget.org/packages/Zeus.Net.NFe.NFCe/) -[![Nuget count](http://img.shields.io/nuget/v/Zeus.Net.NFe.NFCe.svg)](http://www.nuget.org/packages/Zeus.Net.NFe.NFCe/) - Zeus.NFe.NFCe +[![Nuget downloads](https://img.shields.io/nuget/dt/Hercules.NET.Nfe.Nfce.svg)](http://www.nuget.org/packages/Hercules.NET.Nfe.Nfce/) +[![Nuget count](http://img.shields.io/nuget/v/Hercules.NET.Nfe.Nfce.svg)](http://www.nuget.org/packages/Hercules.NET.Nfe.Nfce/) + Hercules.NET.Nfe.Nfce -[![Nuget downloads](https://img.shields.io/nuget/dt/Zeus.Net.MDFe.svg)](http://www.nuget.org/packages/Zeus.Net.NFe.NFCe/) -[![Nuget count](https://img.shields.io/nuget/v/Zeus.Net.MDFe.svg)](http://www.nuget.org/packages/Zeus.Net.MDFe/) - Zeus.MDFe +[![Nuget downloads](https://img.shields.io/nuget/dt/Hercules.NET.MDFe.svg)](http://www.nuget.org/packages/ZHercules.NET.MDFe/) +[![Nuget count](https://img.shields.io/nuget/v/Hercules.NET.MDFe.svg)](http://www.nuget.org/packages/Hercules.NET.MDFe/) + Hercules.NET.MDFe -[![Nuget downloads](https://img.shields.io/nuget/dt/Zeus.Net.CTe.svg)](http://www.nuget.org/packages/Zeus.Net.NFe.NFCe/) -[![Nuget count](https://img.shields.io/nuget/v/Zeus.Net.CTe.svg)](http://www.nuget.org/packages/Zeus.Net.CTe/) - Zeus.CTe +[![Nuget downloads](https://img.shields.io/nuget/dt/Hercules.NET.CTe.svg)](http://www.nuget.org/packages/Hercules.NET.CTe/) +[![Nuget count](https://img.shields.io/nuget/v/Hercules.NET.CTe.svg)](http://www.nuget.org/packages/Hercules.NET.CTe/) + Hercules.NET.CTe -**O que a biblioteca faz:** ------------------- +## O que a biblioteca faz: + O projeto traz classes construídas de forma manual que extraem a complexidade dos XSDs. Com isso é possível preencher objetos nativos em .NET e gerar o XML na estrutura exigida para seu DFe, assim como o processo inverso de ler um XML de um DFe e obter objetos nativos em .NET. Além da serialização e desserialização, o projeto também conta com os métodos de consumo dos webservices (consultar, transmitir, cancelar, inutilizar, etc.), ou seja, com a biblioteca você preenche um objeto nativo em .NET e transmite o seu DFe de forma totalmente transparente, sem se preocupar coma serialização e consumo do webservice. @@ -57,8 +54,8 @@ danfe.Visualizar(); //danfe.Imprimir(); //danfe.ExibirDesign(); ``` -**Como usar a ferramenta:** ------------ +## Como usar a ferramenta: + Antes de qualquer coisa leia os manuais e conheça à fundo o(s) projetos que pretende usar, entenda o que é um DFe (documento fiscal eletrônico), o que é um certificado, como funciona um webservice, o que é obrigatório ser informado no DFe que pretende emitir, entre outras informações. Isso vai ajudar na construção do seu software e na integração com a biblioteca. Com o conhecimento prévio adquirido, agora você precisa estudar a biblioteca. A linguagem utilizada é C#, logo um conhecimento basico da linguagem pode te ajudar bastante, mesmo que você use apenas as dlls com VB.Net ou outra linguagem compatível. @@ -74,8 +71,8 @@ Para facilitar o seus estudos a biblioteca oferece projetos do tipo DEMO, sendo - *NFe.Danfe.AppTeste.Fast:* Projeto em WPF para demonstração de uso da impressão da NFe e NFCe (A NFe e NFCe estão disponíveis em FastReport.Net¹. A NFC-e também está disponível de forma nativa, entretanto para O DEMO é necessária as DLLs do FastReport.Net¹. *A utilização do DANFe da NFCe de forma nativa fora do DEMO não depende do FastReports.Net*); - *NFe.Danfe.AppTeste.OpenFast:* Projeto em Console em .NET6 para demonstração de uso de impressão da NFe, NFCe, como DANFE de xml não registrado e registrado ou Eventos como carta de correção e cancelamento.(A NFe utiliza o FastReport.OpenSource (https://github.com/FastReports/FastReport). Não é necessário nenhuma DLL externa, tudo está incluído no pacote nuget.); -**Impressão (FastReport):** ----------- +## Impressão (FastReport): + - Exemplo no Projeto *NFe.Danfe.AppTeste.Fast*. - A impressão de forma nativa (sem dependências de bibliotecas de terceiros) está disponível somente para a *NFCe*¹. - O projeto conta também com a impressão em FastReport.Net¹ (https://www.fast-report.com/pt/product/fast-report-net/) para *NFe*, *NFCe²* _(térmica)_, *CTe* _(modal rodoviário)_ e *MDFe*. @@ -86,8 +83,8 @@ Para facilitar o seus estudos a biblioteca oferece projetos do tipo DEMO, sendo As fontes estão anexadas ao projeto em Shared.NFe.Danfe.Base\Fontes_; Instale as fontes informadas no PC que for imprimir o DANFE da NFCe_; -**Impressão (OpenFastReport):** ----------- +## Impressão (OpenFastReport): + - Exemplos no Projeto *NFe.Danfe.AppTeste.OpenFast*. - A impressão da NFe utiliza o FastReport.OpenSource (https://github.com/FastReports/FastReport), sendo ele instalado automatico ao utilizar o pacote nuget do Zeus. - A impressão requer que o arquivo .frx seja indicado, ou seja, ao publicar os binarios de seu projeto os arquivos .frx devem estar juntos e passado o caminho do arquivo para que seja gerado a impressão. @@ -136,16 +133,14 @@ COPY suapastadasfontes/* /usr/share/fonts/truetype/times/ O FastReport.OpenSource é pesado na geração de PDF, por isso não recomendamos o mesmo. Para melhor utilização de memoria/cpu, utilize o FastReport.OpenSource para geração em HTML. Na conversão de HTML para PDF, recomendamos o uso do projeto https://github.com/fpanaccia/Wkhtmltopdf.NetCore -**Suporte:** ---------- +## Suporte: + O uso dessa biblioteca não lhe dá quaisquer garantias de suporte. No entanto se tiver dúvidas a respeito do uso desta biblioteca, abra um novo Issue aqui mesmo no github ou pergunte no grupo **Discord** => https://discord.gg/EE4TGKAkkG. -**Colaborando:** ---------- +## Colaborando: + Mantenha seu projeto atualizado para evitar issues desnecessárias, reporte bugs e soluções para problemas comuns, compartilhe suas ideias de melhorias, se tiver condições ajude enviando um pull request ou responda issues de outros colegas. Ao enviar um PR explique brevemente o que foi alterado e o motivo. Teste amplamente as alterações antes de submeter, não remova funcionalidades ou mude regras de métodos já existentes sem aviso prévio e com tempo para adaptações. Colabore, a bibloteca é open source e seu sucesso depende unicamente de sua comunidade. - -**Discord** => https://discord.gg/EE4TGKAkkG