Merge pull request 'Update README.md' (#64) from development_update_readme into development
Reviewed-on: tfgrid/www_projectinca#64
This commit is contained in:
commit
5a012ec055
53
README.md
53
README.md
@ -4,8 +4,11 @@
|
|||||||
|
|
||||||
- [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)
|
||||||
|
- [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)
|
- [License](#license)
|
||||||
- [References](#references)
|
- [References](#references)
|
||||||
- [Contribute](#contribute)
|
- [Contribute](#contribute)
|
||||||
@ -20,29 +23,59 @@ This repository contains the code to deploy the INCA Docs website, a project by
|
|||||||
|
|
||||||
You need [npm](https://www.npmjs.com/) to run this website.
|
You need [npm](https://www.npmjs.com/) to run this website.
|
||||||
|
|
||||||
- Install `npm`
|
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 update
|
||||||
sudo apt install nodejs
|
sudo apt install nodejs
|
||||||
npm -v
|
sudo apt install git
|
||||||
|
sudo apt install make
|
||||||
```
|
```
|
||||||
|
|
||||||
## Website Preview
|
### 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
|
||||||
|
|
||||||
You can preview the website with a few lines.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone https://git.ourworld.tf/tfgrid/www_projectinca
|
git clone https://git.ourworld.tf/tfgrid/www_projectinca
|
||||||
cd www_projectinca
|
cd www_projectinca
|
||||||
npm install
|
|
||||||
npm run dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, read the original [AstroWind docs](./website_docs/README.md).
|
For more information, read the original [AstroWind docs](./website_docs/README.md).
|
||||||
|
|
||||||
## Run with Make
|
## Preview the Website
|
||||||
|
|
||||||
To run the website locally with Make, simply run:
|
You can preview the website with those two lines.
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
The equivalent can be achieved using the Makefile:
|
||||||
|
|
||||||
```
|
```
|
||||||
make run
|
make run
|
||||||
|
Loading…
Reference in New Issue
Block a user