-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add information about the intention and audience of RSS
- Loading branch information
1 parent
cc75583
commit a4c673c
Showing
1 changed file
with
11 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,19 @@ | ||
# Research Software Support | ||
This repository contains the contents for the Research Software Support platform. | ||
This repository contains the contents for the Research Software Support platform. In the Research Software Support modules we want to provide a comprehensive overview of the different aspects of research software support. | ||
|
||
## Target audience | ||
The target audience for this material is University management and support staff. University management taking part in courses involving these modules may be involved in creating university policy around research software. The University support staff targeted are not themselves researchers or software engineers, but they support researchers and research software engineers in creating research software. | ||
|
||
## Technical documentation | ||
This platform uses the [NEBULA framework](https://github.com/esciencecenter-digital-skills/NEBULA). | ||
|
||
For elaborate setup instructions and other documentation, see the [NEBULA documentation](https://github.com/esciencecenter-digital-skills/NEBULA-docs) | ||
|
||
## Quick local setup | ||
|
||
# Quick local setup | ||
More detailed information about local setup can be found in the [NEBULA local rendering docs](https://github.com/esciencecenter-digital-skills/NEBULA-docs/blob/main/local-rendering.md) | ||
|
||
## Content directory/repository | ||
### Content directory/repository | ||
|
||
To use NEBULA to build the content in this repository locally, you will need to clone this repository and the NEBULA repository: | ||
|
||
|
@@ -17,15 +22,15 @@ git clone [email protected]:esciencecenter-digital-skills/research-software-support | |
git clone [email protected]:esciencecenter-digital-skills/NEBULA.git | ||
``` | ||
|
||
## Link to the content repository | ||
### Link to the content repository | ||
|
||
To make sure that NEBULA knows where to find the content, we create the following environment variable: | ||
|
||
```bash | ||
export CONTENT_PATH="~/path/to/your/content/repository" | ||
``` | ||
|
||
## Install dependencies | ||
### Install dependencies | ||
|
||
Install the dependencies using the [node package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm): | ||
|
||
|
@@ -34,7 +39,7 @@ Install the dependencies using the [node package manager](https://docs.npmjs.com | |
npm install | ||
``` | ||
|
||
## Local development build | ||
### Local development build | ||
|
||
Start the development server on `http://localhost:3000`: | ||
|
||
|