@@ -23,18 +23,36 @@ Additionally, you can also navigate to the [repository for theme](https://git-r3
2. Clone this very repository: `git clone ssh://git@git-r3lab-server.uni.lu:8022/core-services/pages-jekyll-lcsb-template.git`.
3. Once cloned, remove the _remote_ (so that every time you push to your repository, you don't push to this very repository):
`cd project_name; git remote rm origin`, and add _remote_ to your repository (you can find the correct remote address in gitlab) **TODO: add screenshot**.
4. Modify site's settings to match your needs. Refer to the next section for help.
4. Modify site's settings (`_config.yml`) to match your needs. Refer to the next section for help.
5. Modify the index page. Modify (or delete) help and about pages. Add your own content.
6. Commit and push to the repository.
7. If you want to have your page publicly available, make a ticket to SIU.
8. Your page is published! Go to `https://<namespace>.pages.uni.lu/name-of-repository` in your favourite browser, or the URL you specified in the SIU ticket.
## What should you change in settings file?
**TODO**
Mandatory:
*`baseurl` - this is very important. Set it to the name of the project (i.e. repository name). Here it's `pages-jekyll-lcsb-template`
Optional:
*`title` field
*`e-mail` field
*`description` field
*`date` field
*`banner` field - if you want to have your own banner (the text next to _uni.lu_ logo), send us an email.
## Testing the web page locally
You can test your website locally (on your machine).
* First, make sure that you have Ruby installed. If not - please [install it](https://www.ruby-lang.org/en/downloads/).
