Skip to content

Commit b41e2b6

Browse files
committed
Add license and readme.md to project folder.
1 parent add3281 commit b41e2b6

3 files changed

Lines changed: 53 additions & 1 deletion

File tree

ChineseCalendarSolution.sln

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DemoApp", "DemoApp\DemoApp.
99
EndProject
1010
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ChineseCalendarLib.Tests", "ChineseCalendarLib.Tests\ChineseCalendarLib.Tests.csproj", "{CD04EFC6-3ACD-90FC-A4E0-FC923B654928}"
1111
EndProject
12+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{8EC462FD-D22E-90A8-E5CE-7E832BA40C5D}"
13+
ProjectSection(SolutionItems) = preProject
14+
LICENSE = LICENSE
15+
README.md = README.md
16+
EndProjectSection
17+
EndProject
1218
Global
1319
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1420
Debug|Any CPU = Debug|Any CPU

LICENSE.txt renamed to LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
GNU GENERAL PUBLIC LICENSE
1+
 GNU GENERAL PUBLIC LICENSE
22
Version 3, 29 June 2007
33

44
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# 🧧 ChineseCalendar
2+
3+
[![License: GPL v3](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0)
4+
[![Build](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)](#)
5+
[![.NET](https://img.shields.io/badge/.NET-8.0-blue?style=flat-square)](https://dotnet.microsoft.com/)
6+
7+
---
8+
9+
## 🧩 Overview
10+
11+
**ChineseCalendar** is a bilingual Chinese lunar calendar and fortune library for **.NET 8**, developed by **skai**.
12+
13+
It provides accurate Chinese lunar–solar date conversion, zodiac (生肖), heavenly stems & earthly branches (干支),
14+
solar terms (节气), and BaZi (八字) fortune calculations — all available in both **Chinese** and **English**.
15+
16+
Ideal for use in cultural, educational, or astrology-related applications.
17+
18+
---
19+
20+
## 🌙 Features
21+
22+
- 🔢 **Lunar ↔ Gregorian date conversion** (农历与公历互转)
23+
- 🐉 **Zodiac & GanZhi (干支)** calculation
24+
- ☯️ **BaZi (八字)** chart generation and explanation
25+
- 🗓️ **Solar Terms (二十四节气)** recognition
26+
- 💫 **Daily, Monthly, and Yearly fortune** summaries with good/bad activities (宜/忌)
27+
- 🌐 **Full bilingual output** (Chinese + English)
28+
- ⚙️ **Compatible with .NET 8**, UTF-8 consoles, and multi-platform projects
29+
30+
---
31+
32+
## 🧠 Usage Example
33+
34+
```csharp
35+
using ChineseCalendarLib;
36+
37+
// Get today's information
38+
var today = ChineseCalendar.GetToday("Asia/Kuala_Lumpur");
39+
Console.WriteLine($"Lunar: {today.LunarTextEN} | Zodiac: {today.ZodiacEN}");
40+
41+
// Get daily fortune for a specific date
42+
var fortune = ChineseCalendar.GetDailyFortune(new DateTime(1990, 5, 17));
43+
Console.WriteLine($"Date: {fortune.Date:yyyy-MM-dd}");
44+
Console.WriteLine($"Zodiac: {fortune.ZodiacEN}");
45+
Console.WriteLine($"Luck Index: {fortune.LuckIndex}/5");
46+
Console.WriteLine($"Overall Fortune: {fortune.OverallFortuneEnglish}");

0 commit comments

Comments
 (0)