Skip to content

Commit 834bf61

Browse files
committed
docs: update readme
1 parent 8621715 commit 834bf61

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

README.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# ORIGO 2025
2+
3+
A documentation website for ORIGO 2025 powered by [Hugo](https://gohugo.io/) and the [Lotus Docs](https://github.com/colinwilson/lotusdocs) theme.
4+
5+
---
6+
7+
## 🚀 Prerequisites
8+
9+
To run this project locally, ensure the following are installed:
10+
11+
- [Git](https://git-scm.com/)
12+
- [Go](https://go.dev/) (version **1.21** or later)
13+
- [Hugo (Extended Version)](https://gohugo.io/) (version **0.140.0** or later)
14+
15+
---
16+
17+
## ⚙️ Installing Prerequisites
18+
19+
### 🐧 Linux
20+
21+
1. **Install Git**
22+
```bash
23+
sudo apt update
24+
sudo apt install git
25+
git --version
26+
```
27+
28+
29+
2. **Install Go**
30+
```bash
31+
wget https://go.dev/dl/go1.21.linux-amd64.tar.gz
32+
sudo tar -C /usr/local -xzf go1.21.linux-amd64.tar.gz
33+
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc
34+
source ~/.bashrc
35+
go version
36+
```
37+
38+
39+
3. **Install Hugo**
40+
```bash
41+
wget https://github.com/gohugoio/hugo/releases/download/v0.140.0/hugo_extended_0.140.0_Linux-64bit.tar.gz
42+
tar -zxvf hugo_extended_0.140.0_Linux-64bit.tar.gz
43+
sudo mv hugo /usr/local/bin/hugo
44+
hugo version
45+
```
46+
47+
### Windows
48+
49+
1. **Install Git**
50+
Download and install from: [here](https://git-scm.com/download/win)
51+
52+
Verify:
53+
54+
```powershell
55+
git --version
56+
```
57+
58+
2. **Install Go (1.21 or later)**
59+
Download the installer from: [here](https://go.dev/dl/)
60+
(e.g., go1.21.windows-amd64.msi)
61+
Run installer → verify:
62+
63+
```powershell
64+
go version
65+
```
66+
67+
3. **Install Hugo Extended (0.140.0 or later)**
68+
Download from: [here](https://github.com/gohugoio/hugo/releases)
69+
70+
Extract `hugo.exe`
71+
72+
Place it in a folder that is in your system PATH, or add the folder manually
73+
Verify:
74+
75+
```powershell
76+
hugo version
77+
```
78+
79+
## 🚀 Deploying website locally for development
80+
81+
82+
1. **Clone the repository:**
83+
84+
```powershell
85+
git clone https://github.com/rignitc/origo25
86+
cd origo25
87+
```
88+
89+
90+
2. **Deploy the Hugo site locally:**
91+
92+
```powershell
93+
hugo server -D
94+
```
95+
96+
97+
3. **Open in browser**
98+
99+
Type or copy `http://localhost:1313/origo25/` into your browser to see the rendered website.

0 commit comments

Comments
 (0)