Skip to content

Commit 44fd03d

Browse files
authored
feat: improve the readme.md (#776)
Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
1 parent 7c56604 commit 44fd03d

File tree

2 files changed

+49
-9
lines changed

2 files changed

+49
-9
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# Python
55
*.pyc
66

7+
# Python virtual environment
8+
/.venv/
9+
710
# Vim
811
*.swp
912
*.swo

README.md

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,52 @@
1-
# Autoware documentation
1+
# Autoware Documentation
22

3-
Welcome to the Autoware Documentation! This repository is specifically designed to manage the source files for Autoware's documentation. If you wish to access the actual documentation, please visit [this link](https://autowarefoundation.github.io/autoware-documentation/main/).
3+
<p align="center">
4+
<img src="./docs/assets/images/autoware-foundation.png" width="128" alt="Autoware Foundation Logo" />
5+
<br />
6+
<a href="https://github.com/autowarefoundation/autoware-documentation/actions"><img src="https://github.com/autowarefoundation/autoware-documentation/actions/workflows/deploy-docs.yaml/badge.svg" alt="Deploy Docs" /></a>
7+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License" /></a>
8+
</p>
49

5-
![autoware_front_image](./docs/assets/images/autoware-foundation.png)
10+
<p align="center">
11+
<strong>The central documentation hub for the <a href="https://github.com/autowarefoundation/autoware">Autoware</a> open-source autonomous driving platform.</strong>
12+
</p>
613

7-
## Notation
14+
<p align="center">
15+
<a href="https://autowarefoundation.github.io/autoware-documentation/main/">📖 Read the Documentation</a>
16+
</p>
817

9-
- This source is deployed using [MKDocs](https://www.mkdocs.org/).
10-
- Autoware consists of [multiple repositories](https://github.com/autowarefoundation/), and this documentation serves as a central hub to access information from each of them.
11-
- For more information about Autoware and its related repositories, refer to the [Autoware Foundation's organization profile](https://github.com/autowarefoundation/.github/blob/main/profile/README.md).
18+
---
1219

13-
## Contributions
20+
## About
1421

15-
To contribute to this repository, see the [documentation guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/documentation-guidelines/).
22+
This repository contains the source files for Autoware's documentation, built and deployed with [MkDocs](https://www.mkdocs.org/). Autoware spans [multiple repositories](https://github.com/autowarefoundation/), and this site serves as a unified entry point to access information across all of them.
23+
24+
For more about the Autoware project and its ecosystem, see the [Autoware Foundation organization profile](https://github.com/autowarefoundation/.github/blob/main/profile/README.md).
25+
26+
## Getting started locally
27+
28+
```bash
29+
# Clone the repository
30+
git clone https://github.com/autowarefoundation/autoware-documentation.git
31+
cd autoware-documentation
32+
33+
# Create and activate a virtual environment
34+
python3 -m venv .venv
35+
source .venv/bin/activate
36+
37+
# Install dependencies
38+
pip install -r mkdocs-requirements.txt
39+
40+
# Serve locally
41+
mkdocs serve
42+
```
43+
44+
Then open [http://localhost:8000](http://localhost:8000) in your browser.
45+
46+
## Contributing
47+
48+
Contributions are welcome! Please review the [documentation guidelines](https://autowarefoundation.github.io/autoware-documentation/main/contributing/documentation-guidelines/) before submitting a pull request.
49+
50+
## License
51+
52+
This project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)