Skip to content

Commit 7836702

Browse files
authored
Merge pull request #5 from CU-ESIIL/codex/update-readme.md-for-minimal-template
Rewrite README as minimal template and website setup guide
2 parents 9d89a3d + 75df508 commit 7836702

1 file changed

Lines changed: 43 additions & 6 deletions

File tree

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,50 @@
1-
# basic_OASIS
1+
# Research Project Template
22

3-
This repository has been reduced to the essentials:
3+
This repository is a **minimal template for research and data science projects** that combine code, documentation, and a project website.
44

5-
- A README.
6-
- A minimal MkDocs website in `docs/`.
5+
It includes:
76

8-
## Local preview
7+
* a clean project structure (`src`, `data`, `docs`, `tests`, etc.)
8+
* a documentation website built with **MkDocs + Material**
9+
* automatic deployment to **GitHub Pages** using GitHub Actions
10+
* development history files (changelog, roadmap, dev log)
11+
* an `AGENTS.md` file with guidance for AI coding agents
912

10-
```bash
13+
The website is built from the `docs/` folder and automatically deployed when changes are pushed.
14+
15+
---
16+
17+
# Enable the Website
18+
19+
After creating a repository from this template you must enable GitHub Pages once.
20+
21+
1. Go to **Settings → Pages**
22+
2. Under **Build and deployment**, choose
23+
**Source: GitHub Actions**
24+
25+
The site will then deploy automatically on push.
26+
27+
Your site will appear at:
28+
29+
```
30+
https://<your-username>.github.io/<repository-name>/
31+
```
32+
33+
---
34+
35+
# Preview Locally
36+
37+
```
1138
pip install mkdocs mkdocs-material
1239
mkdocs serve
1340
```
41+
42+
Then open:
43+
44+
```
45+
http://127.0.0.1:8000
46+
```
47+
48+
---
49+
50+
Use **"Use this template"** on GitHub to start a new project.

0 commit comments

Comments
 (0)