Merge pull request khumnath#3 from opensource-nepal/dev-khumnath

upstream update

Author: khumnath

README.md

@@ -5,119 +5,142 @@ nepdate-cli is a command-line tool for displaying and converting dates between t
 > [!NOTE]  
 > Rust port is available at rust branch of this repository. if you want to install just binary using cargo use
 > ``` cargo install nepdate-cli ```   or use as dependency on Cargo.toml file.  ``` nepdate-cli = "0.1.3" ```
-> check https://github.com/khumnath/nepdate-cli/blob/rust/src/bikram.rs for available functions or https://github.com/khumnath/nepdate-cli/blob/rust/src/main.rs for example uses.
-> read readme file for rust https://github.com/khumnath/nepdate-cli/blob/rust/README.md
+> check https://github.com/opensource-nepal/nepdate-cli/blob/rust/src/bikram.rs for available functions or https://github.com/opensource-nepal/nepdate-cli/blob/rust/src/main.rs for example uses.
+> read readme file for rust https://github.com/opensource-nepal/nepdate-cli/blob/rust/README.md
 
 ### Features
 
 -   Display the current Bikram Sambat date.
 -   Convert dates between Bikram Sambat and Gregorian calendars.
--  Supports very long date range.
+-   Supports date formatting with devnagari script and date format  specifiers.
+-   Supports very long date range.
 
 ### Installation
 
 There are two installation methods available: using a Debian package or compiling from source.
 
 #### From Debian Package
 
-1.  **Download the latest `.deb` file** from the [releases](https://github.com/khumnath/nepdate-cli/releases) page.
+1.  **Download the latest `.deb` file** from the [releases](https://github.com/opensource-nepal/nepdate-cli/releases) page.
 2.  **Install the package** using `dpkg`:
 
-Bash
+    ```bash
+    sudo dpkg -i nepdate-cli_1.0.0_amd64.deb
+    ```
 
-```
-sudo dpkg -i nepdate-cli_1.0.0_amd64.deb
-
-```
-
-Replace `nepdate-cli_1.0.0_amd64.deb` with the filename of the downloaded package.
+    Replace `nepdate-cli_1.0.0_amd64.deb` with the filename of the downloaded package.
 
 
 #### From Source
 
 1.  Clone the repository:
 
-Bash
-```
-git clone https://github.com/khumnath/nepdate-cli.git
-cd nepdate-cli
-```
+    ```bash
+    git clone https://github.com/opensource-nepal/nepdate-cli.git
+    cd nepdate-cli
+    ```
 
 2.  Install dependencies:
 
-Bash
+    ```bash
+    sudo apt-get update
+    sudo apt-get install -y cmake build-essential debhelper devscripts
+    ```
 
-```
-sudo apt-get update
-sudo apt-get install -y cmake build-essential debhelper devscripts
-
-```
-
-* packages debhelper  and devscripts are for building debian installer package.
+    *packages debhelper and devscripts are for building debian installer package.*
 
 3.  Build and install:
 
-Bash
-
-```
-mkdir build
-cd build
-cmake ..
-make
-sudo make install
-
-```
-* if need to build deb package, run ``` dpkg-buildpackage -b``` after ```make```
+    ```bash
+    mkdir build
+    cd build
+    cmake ..
+    make
+    sudo make install
+    ```
 
+    *if need to build deb package with signing, run `dpkg-buildpackage -b` from project root directory. (you have to edit email address to yours in files in /debian folder.)*
+    *`dpkg-buildpackage -b -us -uc` command builds debian package without signing.*
 
 ### Usage
 
 Once installed, you can use nepdate-cli from the command line. Here are some basic commands:
 
--   Display the current Bikram Sambat date:
-
-Bash
+```bash
+nepdate-cli
+```
 
+Output:
 ```
-nepdate-cli
+   Today's Date:
+    Gregorian: 2024 11 15 Friday
+    Bikram Sambat: 2081 8 30 शुक्रवार  days in bikram month: 30
 ```
-output:
-![Screenshot_select-area_20240810182013](https://github.com/user-attachments/assets/7b0f2e84-ec09-44a0-9edc-37bd46a682c4)
-* Convert to Bikram Sambat
+
 ```
- nepdate-cli --conv --tobs 2024 8 10
+Usage:
+  Show today's date: ./ndate --today [--unicode] [--format format_string]
+  Convert to Bikram Sambat Date: ./ndate --tobs year month day [--unicode] [--format format_string]
+  Convert to Gregorian Date: ./ndate --toad year month day [--unicode] [--format format_string]
+Options:
+  --unicode : Display the date in Unicode format (Devanagari script).
+  --format format_string : Specify a custom format for the date (e.g., 'y-m-d', 'd-M-y'). Default: 'y-m-d'
+
+Format Specifiers:
+  y : Year
+  m : Month (numeric)
+  d : Day
+  w : Weekday name
+  M : Month name
+
+Example commands:
+  ./ndate --today --unicode --format 'd-M-y'        : Show today's date in Unicode with custom format.
+  ./ndate --tobs 2024 11 15 --unicode --format 'y-m-d' : Convert a Gregorian date to Bikram Sambat date.
+  ./ndate --toad 2081 8 30 --unicode --format 'y/m/d'  : Convert a Nepali date to Gregorian date.
 ```
-output:
-![Screenshot_select-area_20240810182157](https://github.com/user-attachments/assets/474ff597-829e-4f48-8d16-079673f902fd)
 
+### Examples:
 
-* Convert a Bikram Sambat date to Gregorian:
-```
-nepdate-cli --conv --toad 2081 4 26  
+1. Show today's date in Devanagari script with default format:
+    ```bash
+    ./ndate --today --unicode
+    ```
+    Output: २०८१-८-३०
 
-```
-output:
-![Screenshot_select-area_20240810182318](https://github.com/user-attachments/assets/308500ee-15dc-42a3-a1d5-9d5d729b267b)
+2. Convert a Gregorian date to Bikram Sambat date in Devanagari script:
+    ```bash
+    ./ndate --tobs 2024 11 15 --unicode
+    ```
+    Output: २०८१-८-३०
+
+3. Show today's date with custom format 'd-M-y':
+    ```bash
+    ./ndate --today --format 'd-M-y'
+    ```
+    Output: ३०-श्रावण-२०८१
 
+4. Convert a Bikram Sambat date to Gregorian date with weekday name:
+    ```bash
+    ./ndate --toad 2081 8 30 --format 'w, y-m-d' --unicode
+    ```
+    Output: शुक्रवार, २०८१-८-३०
 
-### ** Replace the date strings with the date you want to convert.
 
-## Contributing
+### Contributing
 
-Contributions are welcome! If you have any bug reports or feature requests, please open an issue on the GitHub [repository](https://github.com/khumnath/nepdate-cli).
+Contributions are welcome! If you have any bug reports or feature requests, please open an issue on the GitHub [repository](https://github.com/opensource-nepal/nepdate-cli).
 
 Here's a quick guide to contributing code:
 
 1.  Fork the repository.
-3.  Create a new branch for your changes.
-5.  Commit your changes and push them to your fork.
-7.  Open a pull request against the main branch of the original repository.
-    
+2.  Create a new branch for your changes.
+3.  Commit your changes and push them to your fork.
+4.  Open a pull request against the main branch of the original repository.
 
 ### License
 
 nepdate-cli is released under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). See the LICENSE file for more details.
 
 ### Contact
 
-For any inquiries, you can reach out to [khumnath](https://khumnath.com.np) cg.
+For any inquiries, you can reach out to [khumnath cg](https://khumnath.com.np) .

debian/control

@@ -4,7 +4,7 @@ Priority: optional
 Maintainer: khumnath <[email protected]>
 Build-Depends: debhelper-compat (= 13), cmake
 Standards-Version: 4.6.1
-Homepage: https://github.com/khumnath/nepdate-cli
+Homepage: https://github.com/opensource-nepal/nepdate-cli
 
 Package: nepdate-cli
 Architecture: any

debian/copyright

@@ -1,7 +1,7 @@
 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: nepdate-cli
 Upstream-Contact: khumnath cg <[email protected]>
-Source: https://github.com/khumnath/nepdate-cli
+Source: https://github.com/opensource-nepal/nepdate-cli
 
 Files: *
 Copyright: 2024 khumnath cg <[email protected]>

debian/upstream/metadata

@@ -1,5 +1,5 @@
 ---
-Bug-Database: https://github.com/khumnath/nepdate-cli/issues
-Bug-Submit: https://github.com/khumnath/nepdate-cli/issues/new
-Repository: https://github.com/khumnath/nepdate-cli/issues.git
-Repository-Browse: https://github.com/khumnath/nepdate-cli
+Bug-Database: https://github.com/opensource-nepal/nepdate-cli/issues
+Bug-Submit: https://github.com/opensource-nepal/nepdate-cli/issues/new
+Repository: https://github.com/opensource-nepal/nepdate-cli/issues.git
+Repository-Browse: https://github.com/opensource-nepal/nepdate-cli

debian/watch

@@ -1,4 +1,4 @@
 version=4
 opts=filenamemangle=s/.+\/v?(\d\S+)\.tar\.gz/toml11-$1\.tar\.gz/ \
-  https://github.com/khumnath/nepdate-cli/tags .*/v?(\d\S+)\.tar\.gz
+  https://github.com/opensource-nepal/nepdate-cli/tags .*/v?(\d\S+)\.tar\.gz
 

src/CMakeLists.txt

@@ -1,11 +1,11 @@
 cmake_minimum_required(VERSION 3.5)
-project(ndate VERSION 1.0.0)
+project(nepdate-cli VERSION 1.0.0)
 
 set(CMAKE_CXX_STANDARD 11)
 
-add_executable(ndate main.cpp)
+add_executable(nepdate-cli main.cpp)
 
 set(CMAKE_INSTALL_PREFIX /usr/local)
 
 # Install the executable (adjust the path if necessary)
-install(TARGETS ndate)
+install(TARGETS nepdate-cli)

src/bikram.h

@@ -1,3 +1,22 @@
+/*
+ * Copyright (C) 2024 Khumnath CG
+ * Email: [email protected]
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+
 #ifndef BIKRAM_H
 #define BIKRAM_H
 #include <iostream>