Merge pull request #29 from esciencecenter-digital-skills/documentation

Documentation

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing to NEBULA
+
+We welcome any support on maintaining and developing the NEBULA framework.
+
+## How can I contribute?
+
+If you have an issue with NEBULA: look whether the issue you have [already exists](https://github.com/esciencecenter-digital-skills/NEBULA/issues) or make a [new issue](https://github.com/esciencecenter-digital-skills/NEBULA/issues/new), and [create a PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) with your changes from a fork or a branch.
+
+If you want to contribute but do not know where to start, look for [an issue you can pick up](https://github.com/esciencecenter-digital-skills/NEBULA/issues), or contact the development team via [email protected] for more guidance.

README.md

@@ -2,73 +2,49 @@
 
 # NEBULA
 
-The NEBULA (Nuxt & eScience Based Universal Learning Application) framework can be used to create an easily maintainable, version-controllable, web-based lesson collection. It is based on [Nuxt.js](https://nuxtjs.org/) and [Vue.js](https://vuejs.org/).
-
-NEBULA is being created as part of the Netherlands eScience Center Digital Skills programme.
-
 Copyright 2023-2024 Netherlands eScience Center
 
+The NEBULA (Nuxt & eScience Based Universal Learning Application) framework can be used to create an easily maintainable, version-controllable, web-based lesson collection. It uses [Nuxt.js](https://nuxtjs.org/) and [Vue.js](https://vuejs.org/).
 
-## Documentation
+NEBULA is being created as part of the Netherlands eScience Center Digital Skills programme.
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+For elaborate setup instructions and other documentation, see the [NEBULA documentation](https://github.com/esciencecenter-digital-skills/NEBULA-docs)
 
-## Setup
 
-Make sure to install the dependencies:
+# Quick setup
 
-```bash
-# npm
-npm install
+## Content directory/repository
 
-# pnpm
-pnpm install
+To use NEBULA you will need to setup a content directory or repository. See the [NEBULA content template repository](https://github.com/esciencecenter-digital-skills/NEBULA-content-template) or the [NEBULA documentation on creating content](https://github.com/esciencecenter-digital-skills/NEBULA-docs/blob/main/content-repo-instantiation.md) for more information.
 
-# yarn
-yarn install
-```
 
-## Development Server
+## Link to the content directory
 
-Start the development server on `http://localhost:3000`:
+To make sure that NEBULA knows which content to build, we create the following environment variable:
 
 ```bash
-# npm
-npm run dev
-
-# pnpm
-pnpm run dev
-
-# yarn
-yarn dev
+export CONTENT_PATH="~/path/to/your/content/directory"
 ```
 
-## Production
 
-Build the application for production:
+## Install dependencies
+
+Install the dependencies using the node package manager:
 
 ```bash
 # npm
-npm run build
-
-# pnpm
-pnpm run build
-
-# yarn
-yarn build
+npm install
 ```
 
-Locally preview production build:
+## Local development build
+
+Start the development server on `http://localhost:3000`:
 
 ```bash
 # npm
-npm run preview
-
-# pnpm
-pnpm run preview
-
-# yarn
-yarn preview
+npm run dev
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+# Contributing
+
+If you want to contribute to the NEBULA framework, please read the [contributing guidelines](https://github.com/esciencecenter-digital-skills/NEBULA/blob/main/CONTRIBUTING.md).