tfgrid/www_projectinca
30
1
Fork 0
Code Issues 10 Pull Requests Packages Projects 1 Releases Wiki Activity

Update README.md #64

Merged
mik-tf merged 1 commits from development_update_readme into development 2024-06-13 13:51:16 +00:00
Conversation 0 Commits 1 Files Changed 1 +102 -69
1 changed files with 102 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

171
README.md
View File

@ -1,70 +1,103 @@
<h1> INCA Docs </h1> <h1> INCA Docs </h1>
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
- [Introduction](#introduction) - [Introduction](#introduction)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Website Preview](#website-preview) - [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu)
- [Run with Make](#run-with-make) - [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew)
- [License](#license) - [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed)
- [References](#references) - [Clone the Repository](#clone-the-repository)
- [Contribute](#contribute) - [Preview the Website](#preview-the-website)
- [License](#license)
--- - [References](#references)
- [Contribute](#contribute)
## Introduction
---
This repository contains the code to deploy the INCA Docs website, a project by [ThreeFold](https://threefold.io).
## Introduction
## Prerequisites
This repository contains the code to deploy the INCA Docs website, a project by [ThreeFold](https://threefold.io).
You need [npm](https://www.npmjs.com/) to run this website.
## Prerequisites
- Install `npm`
``` You need [npm](https://www.npmjs.com/) to run this website.
sudo apt update
sudo apt install nodejs To clone the repository, you need `git`.
npm -v
``` To use the Makefile for quick deployment, you need `make`
## Website Preview ### Install the prerequisites on Ubuntu
```
You can preview the website with a few lines. sudo apt update
sudo apt install nodejs
``` sudo apt install git
git clone https://git.ourworld.tf/tfgrid/www_projectinca sudo apt install make
cd www_projectinca ```
npm install
npm run dev ### Install the prerequisites on MAC or Linux with Brew
```
- [Install Brew](https://brew.sh/)
For more information, read the original [AstroWind docs](./website_docs/README.md). ```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
## Run with Make ```
- Install the prerequisites
To run the website locally with Make, simply run: ```
brew install node
``` brew install git
make run brew install make
``` ```
## License ### Check if the Prerequisites Are Installed
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](./LICENSE.md) file for details. ```
npm --version
## References git version
make --version
This INCA Docs website is based on the amazing [AstroWind repo](https://github.com/onwidget/astrowind). ```
We changed the license from MIT to Apache 2.0 to suit this specific project. ## Clone the Repository
## Contribute
```
To contribute to this repository: git clone https://git.ourworld.tf/tfgrid/www_projectinca
cd www_projectinca
- Make a new branch with `development_` as a prefix (e.g. `development_update`) ```
- Make changes locally on your code editor
- Push changes to the new branch For more information, read the original [AstroWind docs](./website_docs/README.md).
- Make a pull request to `development` branch
## Preview the Website
You can preview the website with those two lines.
```
npm install
npm run dev
```
The equivalent can be achieved using the Makefile:
```
make run
```
## License
**INCA Docs** is licensed under the Apache 2.0 license — see the [LICENSE](./LICENSE.md) file for details.
## References
This INCA Docs website is based on the amazing [AstroWind repo](https://github.com/onwidget/astrowind).
We changed the license from MIT to Apache 2.0 to suit this specific project.
## Contribute
To contribute to this repository:
- Make a new branch with `development_` as a prefix (e.g. `development_update`)
- Make changes locally on your code editor
- Push changes to the new branch
- Make a pull request to `development` branch
The code owners will merge `development` branch to `main` branch. The code owners will merge `development` branch to `main` branch.