Skip to content

Commit

Permalink
Updated the README for windows and linux users
Browse files Browse the repository at this point in the history
  • Loading branch information
tarunsinghofficial committed Mar 4, 2024
1 parent 7df0254 commit 61bb5c1
Showing 1 changed file with 57 additions and 17 deletions.
74 changes: 57 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,77 @@

Welcome to the GitHub project that powers the official [OneBusAway Developer Documentation](http://developer.onebusaway.org).

# Improve the Documentation
## Improve the Documentation

Want to help improve the documentation? Thank you! You can easily improve the official OneBusAway documentation by modifying the Markdown files that comprise it. We welcome any size of contribution, ranging from typos and corrected links, to brand-new tutorials.

# Develop New Features/Fix Bugs
## Develop New Features/Fix Bugs

## Prerequisites
### Prerequisites

* [Ruby](https://www.ruby-lang.org/en/downloads/) >= 2.7
* [Node](https://nodejs.org) >= 12
* [Yarn](https://yarnpkg.com)
Ensure you have the following installed on your system:

## Install
- [Ruby](https://www.ruby-lang.org/en/downloads/) (version >= 2.7)
- [Node.js](https://nodejs.org) (version >= 12)
- [Yarn](https://yarnpkg.com)

```sh
git clone https://github.com/OneBusAway/onebusaway-docs.git
cd onebusaway-docs
bundle install && yarn install
```
### Setting Up Development Environment

#### For Windows Users (via Windows Subsystem for Linux - WSL)

1. Install the [Windows Subsystem for Linux (WSL)](https://gorails.com/setup/windows/10) if you haven't already.
2. After setting up WSL, navigate to the project directory in your Linux subsystem.
3. Fork the repository by clicking the "Fork" button on the [repository page](https://github.com/OneBusAway/onebusaway-docs).
4. Clone the forked repository:

```sh
git clone https://github.com/YourUsername/onebusaway-docs.git
cd onebusaway-docs
```

5. Install dependencies:

```sh
bundle install
yarn install
```

If you encounter any errors, you may run:

```sh
yarn add glob
```

## Development
6. If CSS is not working properly, rebuild frontend assets:

To start your site in development mode, run `bin/bridgetown start` and navigate to [localhost:4000](https://localhost:4000/)!
```sh
bin/bridgetown frontend:build
```

### Commands
#### For Linux Users

1. Fork and clone the repository as described above.
2. Navigate to the project directory.
3. Install dependencies:

```sh
bundle install
yarn install
```

### Development

To start the site in development mode, run:

```sh
# running locally
bin/bridgetown start
```

### Additional Commands

# load the site up within a Ruby console (IRB)
Load the site up within a Ruby console (IRB)

```sh
bin/bridgetown console
```

Expand Down

0 comments on commit 61bb5c1

Please sign in to comment.