Skip to content

Commit

Permalink
docs(readme): add images to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TGRHavoc committed Jul 27, 2021
1 parent 2124bcd commit f7415d2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
27 changes: 18 additions & 9 deletions docs/README.md
Expand Up @@ -10,38 +10,45 @@ permalink: /livemap-interface
[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

<p align="center">
<img alt="LiveMap" src="./images/LiveMap%20logo.svg" width="300" />
</p>
<p align="center">
<img alt="LiveMap" src="./images/d0d5d365dd98f837327849811cd115a06e7b46b94f2a5c17ca1675835f92.gif" />
</p>

This is the Web Interface for the FiveM addon [live_map](https://github.com/TGRHavoc/live_map).

- [Prerequisites](#prerequisites)
- [How to install](#how-to-install)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Adding custom maps](#adding-custom-maps)
- [Developers Information](#developers-information)
- [Frequently Asked Questions](#frequently-asked-questions-)
- [Adding custom maps 🗺️](#adding-custom-maps-️)
- [Developers Information 🧑‍💻](#developers-information-)
- [Contributors ✨](#contributors-)

## Prerequisites

In order to have this working, it is advised that you already have a webserver running and correctly configured.
You will also need to install [live_map](https://github.com/TGRHavoc/live_map) on your FiveM server and have it configured.

## How to install
## How to install

Download the [latest version](https://github.com/TGRHavoc/live_map-interface/archive/master.zip).

This should be enough to get the interface up and running on your website. If you want to change stuff like the images, look in the [configuration](config.md) section.

## Frequently Asked Questions
## Frequently Asked Questions

If you run into any issues, consult the [F.A.Q.](FAQ.md) first. Amongst other things, this document contains information about common issues involving:
- server not connecting/showing up
- unable to communicate with FiveM server
- errors getting blips
- issues with localhost

## Adding custom maps
## Adding custom maps 🗺️
Information on how to add custom maps from GTA or alternative into livemap. See [Custom Maps](custom_maps.md).

## Developers Information
## Developers Information 🧑‍💻

Useful information for developers on dependencies and files locations for development. See [Developers Information](developers.md).

Expand All @@ -58,12 +65,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="https://tomgrobbe.nl/"><img src="https://avatars.githubusercontent.com/u/31419184?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tom</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3ATomGrobbe" title="Bug reports">🐛</a> <a href="https://github.com/TGRHavoc/live_map-interface/commits?author=TomGrobbe" title="Code">💻</a></td>
<td align="center"><a href="https://xlxacidxlx.com/"><img src="https://avatars.githubusercontent.com/u/7502881?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AciD</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3AxlxAciDxlx" title="Bug reports">🐛</a> <a href="https://github.com/TGRHavoc/live_map-interface/commits?author=xlxAciDxlx" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/jiynn"><img src="https://avatars.githubusercontent.com/u/33206565?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jiynn</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3Ajiynn" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/Local9"><img src="https://avatars.githubusercontent.com/u/6077794?v=4?s=100" width="100px;" alt=""/><br /><sub><b>127.0.0.1</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3ALocal9" title="Bug reports">🐛</a> <a href="https://github.com/TGRHavoc/live_map-interface/commits?author=Local9" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/davwheat"><img src="https://avatars.githubusercontent.com/u/7406822?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Wheatley</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/commits?author=davwheat" title="Code">💻</a> <a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3Adavwheat" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/Local9"><img src="https://avatars.githubusercontent.com/u/6077794?v=4?s=100" width="100px;" alt=""/><br /><sub><b>127.0.0.1</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3ALocal9" title="Bug reports">🐛</a> <a href="https://github.com/TGRHavoc/live_map-interface/commits?author=Local9" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/davwheat"><img src="https://avatars.githubusercontent.com/u/7406822?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Wheatley</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/commits?author=davwheat" title="Code">💻</a> <a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3Adavwheat" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/DaveOkpare"><img src="https://avatars.githubusercontent.com/u/19241431?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Okpare</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/commits?author=DaveOkpare" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/matsn0w"><img src="https://avatars.githubusercontent.com/u/15019582?v=4?s=100" width="100px;" alt=""/><br /><sub><b>matsn0w</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/commits?author=matsn0w" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/JasonO99"><img src="https://avatars.githubusercontent.com/u/2074263?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jason Olsen</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3AJasonO99" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/Aaron-Downham"><img src="https://avatars.githubusercontent.com/u/32743520?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aaron-Downham</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/issues?q=author%3AAaron-Downham" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/Annihilator4423"><img src="https://avatars.githubusercontent.com/u/61148120?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Annihilator4423</b></sub></a><br /><a href="https://github.com/TGRHavoc/live_map-interface/commits?author=Annihilator4423" title="Documentation">📖</a></td>
Expand Down
1 change: 1 addition & 0 deletions docs/images/LiveMap logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f7415d2

Please sign in to comment.