Skip to content

Commit f20ddeb

Browse files
Create README.md (#14)
1 parent d4b43d9 commit f20ddeb

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Libevent.org
2+
This repository contains the source code for the libevent website. The site provides documentation, resources, and updates for [libevent](https://github.com/libevent/libevent), an event notification library.
3+
4+
## Overview
5+
The libevent website is hosted by GitHub Pages and built using HTML, CSS, and JavaScript along with Bootstrap for styling and responsiveness.
6+
7+
## Getting Started
8+
To set up a local version of the website for development or testing, follow these steps:
9+
10+
1. **Clone the repository:**
11+
```sh
12+
git clone https://github.com/libevent/libevent.github.com.git
13+
cd libevent.github.com.git
14+
```
15+
2. **Run the website locally:**
16+
17+
For Jekyll: [Testing GitHub Pages Sites Locally](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) <br>
18+
In VSCode: [Live Server Extension](https://ritwickdey.github.io/vscode-live-server/)
19+
4. **Open `http://localhost:XXXX` in your browser to view the site.**
20+
21+
## Project Structure
22+
```sh
23+
libevent-website/
24+
├── images/ # Static images used on the site
25+
├── style.css # Master css stylesheet
26+
├── README.md # Project documentation (this file)
27+
└── [other files] # Additional project files (including HTML files)
28+
```
29+
30+
## Contributors
31+
[![Contributors](https://contrib.rocks/image?repo=libevent/libevent.github.com)](https://github.com/libevent/libevent.github.com/graphs/contributors)

0 commit comments

Comments
 (0)