Skip to content

Commit 8f2600f

Browse files
committed
docs: add LICENSE, CITATION.cff, polish README, fix meta tags
- MIT LICENSE added (where missing) - CITATION.cff with full author metadata (Chandan Sheikder, BIT) - CITATION.cff includes ORCID, DOI, keywords, and repository URL - README.md polished with badges, project structure, usage, and citation section - GitHub Pages: fixed OG/Twitter meta tags (removed 'Front-End Developer') - Author: Chandan Sheikder <chandan@bit.edu.cn>
1 parent a4e4755 commit 8f2600f

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

CITATION.cff

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it using the metadata below."
3+
type: software
4+
title: "Bio-Inspired Navigation Data Generation"
5+
version: "1.0.0"
6+
date-released: "2025-03-23"
7+
doi: "10.5281/zenodo.19097072"
8+
abstract: >-
9+
A production-ready Python package for generating, visualizing, and analyzing bio-inspired navigation research data, with optional ROS 2 integration.
10+
license: MIT
11+
authors:
12+
- family-names: Sheikder
13+
given-names: Chandan
14+
email: chandan@bit.edu.cn
15+
affiliation: "Beijing Institute of Technology (BIT)"
16+
orcid: "https://orcid.org/0000-0003-1459-8747"
17+
repository-code: "https://github.com/Chandan118/Bio-Inspired-Navigation"
18+
keywords:
19+
- "bio-inspired navigation"
20+
- "swarm robotics"
21+
- "autonomous navigation"
22+
- "ROS 2"
23+
- "sensor fusion"
24+
contact:
25+
- name: Chandan Sheikder
26+
email: chandan@bit.edu.cn
27+
website: "https://chandan118.github.io"

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Chandan Sheikder
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)