From cea7cf6923fc59bbdf642a598293f96fe3fc8346 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Wed, 3 Jul 2024 18:57:24 +0000 Subject: [PATCH] Update docs_projectinca/README.md --- docs_projectinca/README.md | 204 ++++++++++++++++++------------------- 1 file changed, 102 insertions(+), 102 deletions(-) diff --git a/docs_projectinca/README.md b/docs_projectinca/README.md index 4bc2272..cfa222a 100644 --- a/docs_projectinca/README.md +++ b/docs_projectinca/README.md @@ -1,103 +1,103 @@ -

Project INCA Docs

- -

Table of Contents

- -- [Introduction](#introduction) -- [Prerequisites](#prerequisites) - - [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu) - - [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew) - - [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed) -- [Clone the Repository](#clone-the-repository) -- [Preview the Website](#preview-the-website) -- [License](#license) -- [References](#references) -- [Contribute](#contribute) - ---- - -## Introduction - -This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io). - -## Prerequisites - -You need [npm](https://www.npmjs.com/) to run this website. - -To clone the repository, you need `git`. - -To use the Makefile for quick deployment, you need `make` - -### Install the prerequisites on Ubuntu -``` -sudo apt update -sudo apt install nodejs -sudo apt install git -sudo apt install make -``` - -### Install the prerequisites on MAC or Linux with Brew - -- [Install Brew](https://brew.sh/) - ``` - /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" - ``` -- Install the prerequisites - ``` - brew install node - brew install git - brew install make - ``` - -### Check if the Prerequisites Are Installed - -``` -npm --version -git version -make --version -``` - -## Clone the Repository - - -``` -git clone https://git.ourworld.tf/tfgrid/info_tfgrid -cd info_tfgrid/docs_projectinca -``` - -For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md). - -## 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 Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight). - -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 - +

Project INCA Docs

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) + - [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu) + - [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew) + - [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed) +- [Clone the Repository](#clone-the-repository) +- [Preview the Website](#preview-the-website) +- [License](#license) +- [References](#references) +- [Contribute](#contribute) + +--- + +## Introduction + +This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io). + +## Prerequisites + +You need [npm](https://www.npmjs.com/) to run this website. + +To clone the repository, you need `git`. + +To use the Makefile for quick deployment, you need `make` + +### Install the prerequisites on Ubuntu +``` +sudo apt update +sudo apt install nodejs +sudo apt install git +sudo apt install make +``` + +### Install the prerequisites on MAC or Linux with Brew + +- [Install Brew](https://brew.sh/) + ``` + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + ``` +- Install the prerequisites + ``` + brew install node + brew install git + brew install make + ``` + +### Check if the Prerequisites Are Installed + +``` +npm --version +git version +make --version +``` + +## Clone the Repository + + +``` +git clone https://git.ourworld.tf/tfgrid/info_tfgrid +cd info_tfgrid/docs_projectinca +``` + +For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md). + +## 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) file for details. + +## References + +This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight). + +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. \ No newline at end of file -- 2.40.1