Skip to content
Open
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,38 @@ This (original) fork is now in a strict maintenance-only mode. Pull requests are
Please see other active forks for further refinements and developments of the tutorial and the emulator:
https://github.com/skilldrick/easy6502/network

## Local setup

To run the project locally follow these steps.

Make sure that the latest version of Ruby is correctly installed on your system, you can use [rbenv](https://github.com/rbenv/rbenv).

Clone the repository:

```bash
git clone https://github.com/skilldrick/easy6502.git
cd easy6502
```

Create a new `Gemfile` in the root of the project with the following content:

```ruby
source 'https://rubygems.org'

gem 'jekyll'
gem 'github-pages', group: :jekyll_plugins
```

Then execute these commands:

```bash
# install the dependencies
gem install bundler
bundle install

# build the project (inside "_site" directory)
bundle exec jekyll build

# serve the project locally and watch for changes (from "_site" directory)
bundle exec jekyll serve
```