Skip to content

Commit c68cfac

Browse files
Merge pull request #17 from priyansh-narang2308/feat/add-readme
[WOC] docs: add comprehensive README.md and project documentation #7
2 parents 2c8d3ca + c2e758b commit c68cfac

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# <img src="./public/logo.png" width="40" height="40" valign="middle"> EvOC User Documentation
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![VitePress](https://img.shields.io/badge/Documentation-VitePress-blueviolet?style=flat-square&logo=vite)](https://vitepress.dev/)
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
6+
7+
Welcome to the official repository for **EvOC (Evolve On Click)** user documentation. This repository contains all the guides, tutorials, and technical documentations for the EvOC framework.
8+
9+
---
10+
11+
## 🛠️ Technology Stack
12+
13+
This repository contains the **documentation site** for EvOC, built with:
14+
15+
- [**VitePress**](https://vitepress.dev/) - Static site generator designed for technical documentation.
16+
- [**Vue.js**](https://vuejs.org/) - Powering the interactivity within the documentation.
17+
- [**Markdown**](https://daringfireball.net/projects/markdown/) - For content creation.
18+
19+
---
20+
21+
## Getting Started
22+
23+
To run this documentation site locally:
24+
25+
1. **Clone the repository:**
26+
```bash
27+
git clone https://github.com/Evolutionary-Algorithms-On-Click/user_docs.git
28+
cd user_docs
29+
```
30+
31+
2. **Install dependencies:**
32+
```bash
33+
npm install
34+
```
35+
36+
3. **Start development server:**
37+
```bash
38+
npm run docs:dev
39+
```
40+
41+
4. **Build for production:**
42+
```bash
43+
npm run docs:build
44+
```
45+
46+
---
47+
48+
## Project Structure
49+
50+
```bash
51+
user_docs/
52+
├── .vitepress/ #VitePress configuration
53+
├── public/ #Assets like images and logos
54+
├── user-guide/ #Detailed guides for EA, ML tuning, etc.
55+
├── install/ #Installation instructions
56+
├── index.md #Homepage
57+
├── introduction.md #Getting started guide
58+
└── package.json #Project dependencies
59+
```
60+
61+
---
62+
63+
## Contributing
64+
65+
We welcome contributions! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
66+
67+
1. Fork the Project
68+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
69+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
70+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
71+
5. Open a Pull Request
72+
73+
---
74+
75+
## License
76+
77+
Distributed under the MIT License. See `LICENSE` for more information.
78+
79+
---
80+
81+
## Meet the Team
82+
83+
Developed with ❤️ by the EvOC Team at Amrita School of Computing. Check out the [Team Page](./team.md) for more details.
84+
85+
---
86+
87+
<p align="center">
88+
<b>Built for the next generation of Evolutionary Computation</b><br>
89+
<a href="https://github.com/Evolutionary-Algorithms-On-Click">GitHub Organization</a>
90+
</p>

0 commit comments

Comments
 (0)