Skip to content

Commit 3645db8

Browse files
committed
Feat: add readme
1 parent 29f2aa3 commit 3645db8

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<img alt="" src="./assets/header.svg">
2+
3+
---
4+
5+
## About
6+
7+
VAT Relief Generator is an open source windows application to simplify the process of generating [BIR](https://www.bir.gov.ph/index.php/home.html) VAT relief files in the Philippines.
8+
9+
## Features
10+
* Maximize the use of your existing Excel skills to simply data encoding using pre-defined templates
11+
* Use drag and drop to easily import your data
12+
* One-click generation of VAT relief files
13+
14+
## Usage
15+
1. Download the latest stable release from the release page.
16+
2. Download a excel template directly from the application or from [here](https://github.com/cpa-coder/vat-relief/blob/main/DebitExpress.VatRelief/template.xltx).
17+
3. Fill in the data in the template. Make sure to read the instruction carefully to properly fill-out the downloaded template.
18+
4. Drag and drop the template to the application.
19+
5. Click the generate button to generate the VAT relief files.
20+
6. The generated files will be saved in the same directory as the template.
21+
7. Validate the generated files using the [BIR Relief v2.3](https://www.bir.gov.ph/index.php/downloadables.html#relief) which includes validation tool.
22+
23+
## License
24+
VAT Relief Generator is licensed under the [MIT License](https://github.com/cpa-coder/vat-relief/blob/main/LICENSE).
25+
26+
## Dependencies
27+
28+
Thank you :gift_heart: to the following projects for making VAT Relief Generator possible:
29+
30+
* [Microsoft .NET](https://dotnet.microsoft.com/en-us/)
31+
* [Material Design In XAML Toolkit](https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit)
32+
* [ClosedXML](https://github.com/ClosedXML/ClosedXML)
33+
34+
## Disclaimer
35+
36+
VAT Relief Generator is not affiliated with the Bureau of Internal Revenue (BIR) of the Philippines. The application is not endorsed by the BIR and is not an official BIR application. The application is provided as-is without any warranty. The author is not responsible for any damages caused by the use of the application.

assets/header.svg

Lines changed: 56 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)