-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
109 lines (105 loc) · 4.65 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE html>
<html>
<head>
<title>BetterString</title>
<meta charset="utf-8">
<link rel="stylesheet" href="assets/css/style.css">
</head>
<body>
<div class="grid-container">
<div class="Header">
<p align="center">
<a href="https://github.com/DerSchinken/BetterString/network/members"><img src="https://img.shields.io/github/forks/DrBumm/BetterString?style=for-the-badge" alt="Forks"></a>
<a href="https://github.com/DerSchinken/BetterString/stargazers"><img src="https://img.shields.io/github/stars/DrBumm/BetterString?style=for-the-badge" alt="Stargazers"></a>
<a href="https://github.com/DerSchinken/BetterString/issues"><img src="https://img.shields.io/github/issues/DrBumm/BetterString?style=for-the-badge" alt="Issues"></a>
<a href="https://python.org/"><img src="https://img.shields.io/badge/Python-%3E%3D3.6-informational?style=for-the-badge&logo=appveyor" alt="Python"></a>
</p>
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<!-- PROJECT LOGO -->
<p align="center">
<h3 align="center">BetterString</h3>
<p align="center">
Like a normal string but with more functionality
<br />
<a href="https://github.com/DerSchinken/BetterString/blob/main/docs/README.md"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/DerSchinken/BetterString/issues">Report Bug</a>
·
<a href="https://github.com/DerSchinken/BetterString/issues">Request Feature</a>
<br />
<a href="https://github.com/DerSchinken/BetterString/">View source code</a>
</p>
</p>
</div>
<div class="Menu">
<!-- TABLE OF CONTENTS -->
<details open="open">
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project"><button>About The Project</button></a>
<ul>
<li><a href="#built-with"><button>Built With</button></a></li>
</ul>
</li>
<li>
<a href="#getting-started"><button>Getting Started</button></a>
<ul>
<li><a href="#prerequisites"><button>Prerequisites</button></a></li>
<li><a href="#installation"><button>Installation</button></a></li>
</ul>
</li>
<li><a href="#usage"><button>Usage</button></a></li>
<li><a href="#roadmap"><button>Roadmap</button></a></li>
<li><a href="#contributing"><button>Contributing</button></a></li>
</ol>
</details>
</div>
<div class="Main">
<!-- ABOUT THE PROJECT -->
<h2 id="about-the-project">About The Project</h2>
<h3 id="built-with">Built With</h3>
<ul>
<li><a href="https://python.org/">Python</a></li>
</ul>
<!-- GETTING STARTED -->
<h2 id="getting-started">Getting Started</h2>
<h3 id="prerequisites">Prerequisites</h3>
<p>Python >= 3.6</p>
<p>It is installing tabulate but that is not needed (at least now) it is for and planned feature</p>
<h3 id="installation">Installation</h3>
<ol>
<li>Open a terminal</li>
<li><code>pip install BetterString</code>
<br>If it doesn't work, try:<br><code>pip3 install BetterString</code></li>
</ol>
<p>If it still doesn't work install pip or install a supported python version.</p>
<!-- USAGE EXAMPLES -->
<h2 id="usage">Usage</h2>
<p>Go to the <a href="https://github.com/DerSchinken/BetterString/blob/main/docs/README.md">Documentation</a></p>
<!-- ROADMAP -->
<h2 id="roadmap">Roadmap</h2>
<p>See the <a href="https://github.com/DerSchinken/BetterString/issues">open issues</a> for a list of proposed features (and known issues).</p>
<!-- CONTRIBUTING -->
<h2 id="contributing">Contributing</h2>
<p>Contributions are what makes the open source community such an amazing place to learn, inspire and create. Any contributions you make are <strong>greatly appreciated</strong>.</p>
<ol>
<li>Fork the Project</li>
<li>Create your Feature Branch <code>git checkout -b feature/AmazingFeature</code></li>
<li>Commit your Changes <code>git commit -m 'Add some AmazingFeature'</code></li>
<li>Push to the Branch <code>git push origin feature/AmazingFeature</code></li>
<li>Open a Pull Request</li>
</ol>
</div>
<div class="Footer"></div>
</div>
</body>
</html>