Skip to content

Create README.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create README.md #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Libevent.org
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.

## Overview
The libevent website is hosted by GitHub Pages and built using HTML, CSS, and JavaScript along with Bootstrap for styling and responsiveness.

## Getting Started
To set up a local version of the website for development or testing, follow these steps:

1. **Clone the repository:**
```sh
git clone https://github.com/libevent/libevent.github.com.git
cd libevent.github.com.git
```
2. **Run the website locally:**

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>
In VSCode: [Live Server Extension](https://ritwickdey.github.io/vscode-live-server/)
4. **Open `http://localhost:XXXX` in your browser to view the site.**

## Project Structure
```sh
libevent-website/
├── images/ # Static images used on the site
├── style.css # Master css stylesheet
├── README.md # Project documentation (this file)
└── [other files] # Additional project files (including HTML files)
```

## Contributors
[![Contributors](https://contrib.rocks/image?repo=libevent/libevent.github.com)](https://github.com/libevent/libevent.github.com/graphs/contributors)