pyreadme 1.0.1
Create a beautiful README.md!
License: MIT


<h1 id="pyreadme">Python-Readme</h1>

Python-Readme is simple module, which can teach you and which can create you beautiful README, anyway you want!

* <a href="#install">INSTALLATION</a><br/>
	* <a href="#upgrade">UPGRADE</a><br/>
* <a href = "#usage">USAGE</a><br/>
* <a href = "#update">UPDATES AND VERSION</a><br/>
	* <a href="#zerozero">Version 1.0</a><br/>
* <a href = "#about">ABOUT</a><br/>
* <a href = "#help">HELP</a><br/>
  * <a href = "#app">Application</a><br/>
	* <a href = "#help2">How to find help page?</a><br/>
	* <a href = "#font">How to use font?</a><br/>
	* <a href = "#ver">How create Updates and Version page?</a><br/>
	* <a href = "#help3">How to create Help page?</a><br/>
	* <a href = "#tbl">How to create Table?</a><br/>
  * <a href = "#error">Error</a><br/>
	  * <a href = "#attribute">AttributeError:</a><br/>
* <a href = "#contact">CONTACT</a><br/>
<br/>

<h2 id="install">INSTALLATION</h2>

See the <a href="https://pypi.org/project/pyreadme/">PyPi</a> page for more information.<br/><br/>

***Python3***<br/>
`pip3 install pyreadme` <br/>

***Python***<br/>
`pip install pyreadme` <br/>
<br/>


If you want to download source code (zip file) you can download it <a href="https://github.com/tucnakomet1/Python-Readme/archive/master.zip">here</a>.<br/><br/>
Or if you are Linux user type into the terminal:<br/> `git clone https://github.com/tucnakomet1/Python-Readme.git`
<br/><br/>


<h3 id="upgrade">UPGRADE</h3>

***Python3***<br/>
`pip3 install pyreadme --upgrade`<br/>

***Python***<br/>
`pip install pyreadme --upgrade`<br/>
<br/><br/><br/><br/><br/><br/><br/><br/><br/>



<h2 id="usage">USAGE</h2>

```python
>>> import pyreadme

##### Get help #####
>>> pyreadme.help()

##### See license #####
>>> pyreadme.license()

##### Contact #####
>>> pyreadme.contact()


##### Create Title #####
>>> pyreadme.CreateTitle(TITLE)[0]

##### Create Subtitle #####
>>> pyreadme.CreateSubtitle(SUBTITLE)

##### Create Image #####
>>> pyreadme.CreateImage(URL)

##### Create Installation base #####
>>> pyreadme.CreateInstallation()

##### Create Usage base #####
>>> pyreadme.CreateUsage(USAGE, LANGUAGE)   →  LANGUAGE = Python3, Java, GO, etc...

##### Create Table #####
>>> pyreadme.CreateTable(LIST1, LIST2, ... , LIST6)   →   There have to be 2 - 6 lists

##### Create Updates and Version #####
>>> pyreadme.CreateVersion(VERSION, TEXT)   →   VERSION = 1.0, 0.0.1, etc...

##### Create About #####
>>> pyreadme.CreateAbout(ABOUT)

##### Create Help #####
>>> pyreadme.CreateHelp(LIST1, LIST2, LIST3, LIST4)   →   There have to be 2 or 4 lists
                                                      →   LIST1 = Name of help title
													  →   LIST2 = Text of help title
	                                                  →   LIST3 = Name of help-error title
                                                      →   LIST4 = Text of help-error title

##### Create URL #####
>>> Pyreadme.CreateUrl(NAME, URL)

##### Create License #####
>>> pyreadme.CreateLicense(NAME, URL)

##### Create Contact #####
>>> pyreadme.CreateContact(E-MAIL)

##### Create Font (bold, italic, bold-italic, blackquotes) #####
>>> pyreadme.bold(TEXT)
>>> pyreadme.italic(TEXT)
>>> pyreadme.ItalBol(TEXT)
>>> pyreadme.quotes(TEXT)   →  quote text must be at the beginning of article

##### Create UP button #####
>>> pyreadme.UP(TITLE)

```
<br/><br/><br/><br/><br/><br/><br/><br/>

<h2 id="update">UPDATES AND VERSION </h2>

<h3 id="zerozero"> Version 1.0 </h3> 

<em>Actuall version</em><br/>
- supported MacOS, Windows and Linux
- Create whole README
- Teach you how to use README
<br/><br/><br/><br/><br/><br/><br/><br/><br/>


<h2 id="about">ABOUT</h2>

This scrript is created with the help of language Pyhon3. Python-Readme is simple module, which can teach you and which can create you beautiful README, anyway you want!.<br/> I tried to do my best so I hope everything is working. If you have some problem, please let me <a href = "#error">know</a>.<br/>
<br/><br/><br/><br/><br/><br/><br/><br/>


<h2 id="help">HELP</h2>

* <a href = "#app">Application</a><br/>
	* <a href = "#help2">How to find help page?</a><br/>
	* <a href = "#font">How to use font?</a><br/>
	* <a href = "#ver">How create Updates and Version page?</a><br/>
	* <a href = "#help3">How to create Help page?</a><br/>
	* <a href = "#tbl">How to create Table?</a><br/>
* <a href = "#error">Error</a><br/>
	* <a href = "#attribute">AttributeError:</a><br/>
<br/><br/>

 <h2 id = "app"> Application </h2>


<h3 id="help2"> How to find help page? </h3>

```python
>>> import pyreadme 
>>> pyreadme.help()
```
<br/>

<h3 id="font"> How to use font? </h3>
In pyreadme module are 4 fonts to use:<br/>

1) **BOLD**<br/>
-> **Example of bold text**
```Python3
>>> pyreadme.bold(TEXT)
```

2) **ITALIC**<br/>
-> *Example of italic text*
```Python3
>>> pyreadme.bold(TEXT)
```

3) **BOLD-ITALIC**<br/>
-> ***Example of bold-italic text***
```Python3
>>> pyreadme.ItalBol(TEXT)
```

4) **BLACKQUOTES**<br/>
>Example of blackquotes text
```Python3
>>> pyreadme.quotes(TEXT)
```
<br/>

<h3 id="ver"> How create Updates and Version page? </h3>
VERSION must be a number (1.0/ 0.0.1/ 1.0.1/ etc...)<br/>
TEXT can be anything <br/>

```Python3
>>> pyreadme.CreateVersion(VERSION, TEXT)
```
<br/>

<h3 id="help3"> How to create Help page? </h3>

There have to be 2 or 4 lists <br/>
LIST1 = Name of help title <br/>
LIST2 = Text of help title <br/>
LIST3 = Name of help-error title <br/>
LIST4 = Text of help-error title <br/>

```Python3
>>> pyreadme.CreateHelp(LIST1, LIST2, LIST3, LIST4)
```
<br/>
<h3 id="tbl"> How to create Table? </h3>

In table module must be 2 - 6 lists.<br/>
The first word in the list will be at the top of the table. <br/>

```Python3
>>> pyreadme.CreateTable(LIST1, LIST2, ... , LIST6)
```

<br/>
For more information about usage go <a href="https://github.com/tucnakomet1/Python-Readme#usage">here</a>.<br/><br/>
<br/><br/>

 <h2 id = "error"> Error </h2>

<h3 id="attribute"> AttributeError: 'NoneType' object has no attribute '...' </h3><br/>

This error means that you used / entered an object that doesn't exist. It is probably typing error.<br/>
Make sure you wrote everything <a href="#usage">correctly</a>.
<br/><br/><br/><br/><br/><br/><br/><br/>


<h2 id="license">LICENSE</h2>

[MIT](https://github.com/tucnakomet1/Python-Readme/blob/master/LICENSE.txt)


<h2 id="contact">CONTACT</h2>
You can contact me via my <a href="https://mail.google.com/mail/u/0/?view=cm&fs=1&to=tucnakomet@gmail.com&su=Python-Readme&&tf=1">gmail</a> address <a href="mailto:tucnakomet@gmail.com">tucnakomet@gmail.com</a>.<br/>
 <br/><br/>


 <a href = "#pyreadme"><span title="Go UP!"><img alt="up" src="https://ps.w.org/wpfront-scroll-top/assets/icon.svg?rev=1534312" width="40" height="40" style="border:0px solid;" /></a></span>
 <a href = "https://pypi.org/user/Tucnakomet/"><span title="PyPi"><img alt="pypi" src="https://miro.medium.com/max/660/1*2FrV8q6rPdz6w2ShV6y7bw.png" width="40" height="40" style="border:0px solid;" /></a></span>
  <a href = "https://github.com/tucnakomet1"><span title="GitHub"><img alt="github" src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/91/Octicons-mark-github.svg/1200px-Octicons-mark-github.svg.png" width="40" height="40" style="border:0px solid;" /></a></span>