Skip to content

Commit dd408dd

Browse files
committed
add : readme added.
1 parent cc3fee6 commit dd408dd

1 file changed

Lines changed: 92 additions & 0 deletions

File tree

README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<div align="center">
2+
<h1>TODO</h1>
3+
<br/>
4+
<a href="https://badge.fury.io/py/TODO"><img src="https://badge.fury.io/py/TODO.svg" alt="PyPI version"></a>
5+
<a href="https://codecov.io/gh/openscilab/TODO"><img src="https://codecov.io/gh/openscilab/TODO/branch/dev/graph/badge.svg?token=T9T0EPB3V2"></a>
6+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
7+
<a href="https://github.com/openscilab/TODO"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/openscilab/TODO"></a>
8+
<a href="https://discord.gg/TODO"><img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel"></a>
9+
</div>
10+
11+
----------
12+
13+
14+
## Overview
15+
<p align="justify">
16+
TODO
17+
</p>
18+
19+
<table>
20+
<tr>
21+
<td align="center">PyPI Counter</td>
22+
<td align="center">
23+
<a href="https://pepy.tech/projects/TODO">
24+
<img src="https://static.pepy.tech/badge/TODO">
25+
</a>
26+
</td>
27+
</tr>
28+
<tr>
29+
<td align="center">Github Stars</td>
30+
<td align="center">
31+
<a href="https://github.com/openscilab/TODO">
32+
<img src="https://img.shields.io/github/stars/openscilab/TODO.svg?style=social&label=Stars">
33+
</a>
34+
</td>
35+
</tr>
36+
</table>
37+
<table>
38+
<tr>
39+
<td align="center">Branch</td>
40+
<td align="center">main</td>
41+
<td align="center">dev</td>
42+
</tr>
43+
<tr>
44+
<td align="center">CI</td>
45+
<td align="center">
46+
<img src="https://github.com/openscilab/TODO/actions/workflows/test.yml/badge.svg?branch=main">
47+
</td>
48+
<td align="center">
49+
<img src="https://github.com/openscilab/TODO/actions/workflows/test.yml/badge.svg?branch=dev">
50+
</td>
51+
</tr>
52+
</table>
53+
54+
55+
## Installation
56+
57+
### PyPI
58+
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
59+
- Run `pip install TODO==0.1`
60+
### Source code
61+
- Download [Version 0.1](https://github.com/openscilab/TODO/archive/v0.1.zip) or [Latest Source](https://github.com/openscilab/TODO/archive/dev.zip)
62+
- Run `pip install .`
63+
64+
## Usage
65+
66+
TODO
67+
68+
## Issues & bug reports
69+
70+
Just fill an issue and describe it. We'll check it ASAP! or send an email to [TODO@openscilab.com](mailto:TODO@openscilab.com "TODO@openscilab.com").
71+
72+
- Please complete the issue template
73+
74+
You can also join our discord server
75+
76+
<a href="TODO">
77+
<img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
78+
</a>
79+
80+
## References
81+
82+
## Show your support
83+
84+
85+
### Star this repo
86+
87+
Give a ⭐️ if this project helped you!
88+
89+
### Donate to our project
90+
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
91+
92+
<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/TODO/raw/main/otherfiles/donation.png" width="270" alt="TODO Donation"></a>

0 commit comments

Comments
 (0)