diff --git a/README.md b/README.md new file mode 100644 index 0000000..26ccd81 --- /dev/null +++ b/README.md @@ -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)
+ 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)