Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.31 KB

readme.md

File metadata and controls

85 lines (55 loc) · 2.31 KB
Raw

Interrupt is a community for embedded software makers and professionals alike.

Contributing

Interrupt welcomes submissions on embedded software topics.

Prior to getting in touch, you should get yourself acquainted with our Code of Conduct.

To submit your content, either email us at [email protected], or open a pull request!

See Contributing for more information.

Running

Docker (Recommended)

Follow the instructions in the Install Docker Engine according to your operating system.

Clone the repo, run in docker:

$ git clone https://github.com/memfault/interrupt.git
$ cd interrupt
$ ./interrupt-server.sh

You can now access the server at http://0.0.0.0:4000

Locally

You'll need:

  • Python 3.8 or later
  • Ruby 3.2.2

Install Dependencies

Clone the repo and install Python dependencies:

$ git clone https://github.com/memfault/interrupt.git
$ cd interrupt
# Setup a virtual environment to avoid cluttering your system
$ python3 -m venv .venv
# Activate the environment
$ source .venv/bin/activate
$ pip install -r requirements.txt

The virtual environment can be deactivated with deactivate.

We highly recommend setting up a version manager for Ruby, such as rbenv. Follow the instructions here to set it up for your operating system and install the right version of Ruby.

Install Ruby dependencies:

# Check that your Ruby version is correct
$ ruby -v
$ bundle install

Launch

Serve with the following command, which will also open up the site in your browser:

$ bundle exec jekyll serve --drafts --livereload --open-url

Acknowledgements

Interrupt is based on the Emerald theme by Jacopo Rabolini. Emerald is available on Github.

Interrupt is sponsored and edited by Memfault.