Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
initial commit of README file, detailing what PiBakery is, where you can learn more, and how to install from source
  • Loading branch information
davidferguson authored Jul 31, 2016
1 parent bb7d608 commit c0fe1ae
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# PiBakery
The blocks based, easy to use setup tool for Raspberry Pi

![PiBakery demo screen](http://pibakery.org/test/img/blocks-on-workspace.png)

PiBakery is a a blocks based drag and drop tool that allows you to customise and edit your Raspberry Pi without powering the Pi on. Simply insert your SD card into your computer, choose which features you want on your Pi, and hit **Write**. PiBakery will write the latest version of Raspbian to your SD card, with your customisations added too.

For more information see www.PiBakery.org or follow [@PiBakery](http://twitter.com/PiBakery) on Twitter.

</br>
---

# Installing from source

While it is recommended to install PiBakery from one of the downloads on www.PiBakery.org/download.html, you can also install PiBakery from source if you want to see how it works, or edit PiBakery in any way.

To install PiBakery from source, you'll need NodeJS and npm installed. Once you have them installed, clone the GitHub repository with
</br>
`git clone https://github.com/davidferguson/pibakery.git`

Change into the newly downloaded directory with
</br>
`cd pibakery`

And install the required node modules using
</br>
`npm install`
</br>
This will take a few minutes to complete.

You can then run PiBakery using
</br>
`npm start`

When PiBakery is run for the first time, it will give an error about not being able to find Raspbian. This is because Raspbian is the entire Raspberry Pi OS, and is too large to fit in the GitHub repository. By clicking `Attemp Auto-Fix` PiBakery will download Raspbian for you into the `os` directory. Once this download has completed, you're ready to start using PiBakery.

0 comments on commit c0fe1ae

Please sign in to comment.