Skip to content

Commit a0ea7ab

Browse files
committed
Update readme.
1 parent 196c52a commit a0ea7ab

1 file changed

Lines changed: 69 additions & 2 deletions

File tree

README.md

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
1-
# WFDB website
1+
# WFDB Website
22

3-
This repository contains code for the [WFDB website](https://wfdb.io/).
3+
This repository contains the source code for the official Waveform Database (WFDB) project website, built using [Jekyll](https://jekyllrb.com/) and the [Just the Docs](https://just-the-docs.github.io/just-the-docs/) theme. The site serves as a central resource for the WFDB community, providing:
4+
5+
- A specification for the WFDB format.
6+
- An overview of WFDB software implementations.
7+
8+
The website is hosted at [https://wfdb.io](https://wfdb.io).
9+
10+
## About WFDB
11+
12+
The Waveform Database (WFDB) is a set of open file format standards for physiological waveform and annotation data. Originally developed by George B. Moody in 1989 at the Harvard-MIT Division of Health Sciences and Technology, WFDB has become a widely adopted standard in the field of biomedical signal processing.
13+
14+
WFDB files typically consist of:
15+
16+
- **Header files** (`.hea`): Contain metadata about the recording.
17+
- **Signal files** (`.dat`): Store the waveform data.
18+
- **Annotation files** (`.atr`, `.ann`, etc.): Contain annotations such as beat labels or event markers.
19+
20+
For more details, refer to the [WFDB Format Specification](https://wfdb.io/spec/).
21+
22+
## Repository Structure
23+
24+
- `_config.yml`: Jekyll site configuration.
25+
- `Gemfile`: Ruby gem dependencies.
26+
- `index.md`: Homepage content.
27+
- `spec/`: Contains pages related to the WFDB format specification.
28+
- `software/`: Contains pages describing WFDB software implementations.
29+
- `working-group.md`: Information about the WFDB Working Group.
30+
31+
## Installation
32+
33+
To build and serve the website locally, follow these steps:
34+
35+
1. **Install Ruby and Bundler**
36+
37+
Ensure you have Ruby installed. Then, install Bundler:
38+
39+
```bash
40+
gem install bundler
41+
```
42+
43+
2. **Clone the Repository**
44+
45+
```bash
46+
git clone https://github.com/wfdb/wfdb.github.io.git
47+
cd wfdb.github.io
48+
```
49+
50+
3. **Install Dependencies**
51+
52+
```bash
53+
bundle install
54+
```
55+
56+
4. **Serve the Site Locally**
57+
58+
```bash
59+
bundle exec jekyll serve
60+
```
61+
62+
The site will be available at `http://127.0.0.1:4000/`.
63+
64+
## Contributing
65+
66+
Contributions are welcome! If you'd like to contribute to the WFDB website, please fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you'd like to change.
67+
68+
## License
69+
70+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)