Skip to content

Commit 571a045

Browse files
authored
Update README.md
1 parent 4b10fbc commit 571a045

1 file changed

Lines changed: 2 additions & 43 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,5 @@
11
[![theme badge](https://img.shields.io/badge/ELIXIR%20toolkit%20theme-jekyll-blue?color=0d6efd)](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme)
22

3-
# ELIXIR Toolkit Theme example
3+
# Automating FAIR Training Metadata Pipelines: Bioconductor into TeSS and Beyond (BITS)
44

5-
This repository serves as an example on how to deploy the [ELIXIR Toolkit Theme](https://elixir-belgium.github.io/elixir-toolkit-theme).
6-
7-
## Why this separate repo
8-
9-
This repo should demonstrate how easy it is to setup the theme, but more importantly, to show how small the amount is you need. This is really the fresh, bare bone start you want when using the theme from scratch. This way of using the theme will also make sure that your own content is not cluttered with theme files and that you can easily stay up to date when improvements to the theme are made.
10-
11-
## Get started
12-
13-
### 1. Fork this repository
14-
15-
Click on the `Fork` button in the top right of GitHub to fork this repository.
16-
17-
### 2. Deploy using GitHub Actions
18-
19-
1. Go to Settings > Pages and enable GitHub Actions as a source
20-
2. Go to Environments > github-pages and remove the rule under Deployment branches if you want to deploy other branches than master or main via Workflow Dispatch (manually triggered action)
21-
3. Push a change to master/main branch and the GitHub Actions will be triggered.
22-
23-
**Deploy using GitHub Pages (alternative)**
24-
25-
This is the quickest way to deploy the elixir-toolkit-theme, but gives less flexibility and does not allow you to make use of the new way of tagging tools. Visit the [GitHub documentation](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/) to find out more about how to setup GitHub pages.
26-
27-
NOTE: This way of deploying does not support the tool-tag in the text of the Markdown file to tag tools and resources.
28-
29-
### 3. Checking out your deployment
30-
31-
After waiting a minute or two (deployments can take a while), you can checkout your website. THe deployment is by default served at https://USER.github.io/FORK-NAME/.
32-
33-
### 4. Making changes
34-
35-
Any change to the master/main branch will automatically trigger the re-deployment of the website, so your changes come live. More information on how you can configure the theme can be found using these links:
36-
37-
- [Changing the navigation structures](https://elixir-belgium.github.io/elixir-toolkit-theme/navigation_structures)
38-
- [Configuring the theme](https://elixir-belgium.github.io/elixir-toolkit-theme/configuring_theme)
39-
- [Applying custom branding](https://elixir-belgium.github.io/elixir-toolkit-theme/custom_branding)
40-
- [Markdown cheat sheet](https://elixir-belgium.github.io/elixir-toolkit-theme/markdown_cheat_sheet)
41-
42-
And many more documentation pages can be found on the original [ELIXIR Toolkit Theme website](https://elixir-belgium.github.io/elixir-toolkit-theme).
43-
44-
### 5. Add a LICENSE file to your GitHub repository.
45-
46-
Add a license to your repository using the [GitHub instructions](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository).
5+
Project website for [Research Software Maintenance Fund (RSMF)](https://www.software.ac.uk/research-software-maintenance-fund/rsmf-round-2-projects) from The Institute for Research Software.

0 commit comments

Comments
 (0)