Skip to content

Commit f38077d

Browse files
authored
Add README with instructions on how to run the project (#142)
1 parent 9ca3d11 commit f38077d

2 files changed

Lines changed: 64 additions & 0 deletions

File tree

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# ALICE Software Documentation
2+
3+
Documentation for the ALICE software build infrastructure and development workflows.
4+
5+
## Overview
6+
7+
This repository contains documentation for ALICE collaboration software, including tutorials for Git workflows, build infrastructure details, and operational guides.
8+
9+
## Development
10+
11+
This site is built using [MkDocs](https://www.mkdocs.org/) with the Material theme.
12+
13+
### Requirements
14+
15+
- Python 3.8+
16+
- MkDocs
17+
- MkDocs Material theme
18+
19+
### Installation
20+
21+
Optionally, create a virtual environment:
22+
23+
```bash
24+
python -m venv venv
25+
source venv/bin/activate
26+
```
27+
28+
Install dependencies:
29+
30+
```bash
31+
pip install -e .
32+
```
33+
34+
### Local Development
35+
36+
To serve the documentation locally:
37+
38+
```bash
39+
mkdocs serve
40+
```
41+
42+
The site will be available at `http://127.0.0.1:8000/`
43+
44+
### Building
45+
46+
To build the static site:
47+
48+
```bash
49+
mkdocs build
50+
```

pyproject.toml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[project]
2+
name = "alisw.github.io"
3+
version = "1.0.0"
4+
description = "ALICE software documentation"
5+
readme = "README.md"
6+
requires-python = ">=3.8"
7+
dependencies = [
8+
"mkdocs>=1.5.0",
9+
"mkdocs-material>=9.0.0",
10+
]
11+
12+
[project.urls]
13+
Homepage = "https://github.com/alisw/alisw.github.io"
14+
Documentation = "https://alisw.github.io"

0 commit comments

Comments
 (0)