Adding your repository

This guide will help you publish your repository to the TGX website.

Step 1: Editing your readme.md

Your readme.md probably already has parts of the information we want to show on the TGX-overview webpage.
This information needs to be enclosed using opening- and closing tags.
There are two approaches to editing your readme.md file:

• Use the template.

Use this template by clicking the link, then pressing "raw" in the topright corner and copy the text.
Then paste the template text into your readme.md and change the text between the "{{ Replace by... }}" annotations.
If you don't know what to fill in for a tag you can just delete the line.
You can now save your readme.md and continue to step 2.

• Adding tags to your current readme.md.

A list of usable tags can be found here.
A short description of what is meant with each tag can be found in the template.
You can now add an opening tag before the relevant information in your readme.md, eg. """".
Then add a closing tag behind the information, eg. """".
Do this for each tag you want to use and save your readme.md, then continue to step 2.

Step 2: Add your software package to the TGX-overview.

This step can also be completed in two ways:

• Find the rawlink to your readme and create a PR.

The rawlink of your readme can be found by clicking the readme.md file on your github repository, then clicking "raw" in the topright corner.
The rawlink is the URL found in the address bar.
You can now add this rawlink and the title of your project to this file and send me a PR.
Have no idea how to do the above? Don't worry, that's what the second option is for (however, if you want to learn how to do this, let me know!).

• Shoot me a mail.

Just send me a quick mail mentioning the URL to your repository and I will add your project to the TGX-overview webpage.

How does it work?

1. A python script on the TGX-overview website will run routinely.
2. The script downloads the readme.md file on your repository.
3. It will then search for the tags in your file and extract the information between the opening- and closing tag.
4. The information is then stored or updated in the TGX-overview database.
5. The TGX-overview database is then used to create webpages showing the new information about your repository.