Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Readme heading formatting #95

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Lightpack project with Prismatik flavour
calculate resulting colors and provide soft and gentle lighting with Lightpack device. Moreother, you can
handle another devices with Prismatik such as Adalight, Ardulight or even Alienware LightFX system.

#####Main features:
##### Main features:
* Fully open-source under GPLv3 (hardware, software, firmware)
* Cross-platform GUI (Qt)
* USB HID (no need to install any drivers)
* The device is simple to build (just Do-It-Yourself)

#####Useful URLs:
##### Useful URLs:
* [Project mothership] (https://github.com/woodenshark/Lightpack/)
* [Original project mothership] (https://code.google.com/p/lightpack/)
* [Binary downloads] (https://github.com/woodenshark/Lightpack/releases)
Expand All @@ -32,19 +32,19 @@ handle another devices with Prismatik such as Adalight, Ardulight or even Alienw

---

###Prismatik build instructions for Windows
####Prerequisites:
### Prismatik build instructions for Windows
#### Prerequisites:
* [Qt SDK](http://qt-project.org/downloads)
* [Microsoft DirectX SDK](http://www.microsoft.com/en-us/download/details.aspx?id=6812)
* POSIX shell utilities [MSYS for example](http://www.mingw.org/wiki/MSYS). Make sure `PATH` environment variable is set for the utilities (Run → sysdm.cpl → Advanced → Environment Variable → Edit `PATH` system variable (`C:\MinGW\msys\1.0\bin;` for example), path should points directly on the utilities so utilities are available without any subdirectories)

####Build process:
#### Build process:
1. build **Prismatik** project

---

###Build instructions for Linux
####Prerequisites:
### Build instructions for Linux
#### Prerequisites:
You will need the following packages, usually all of them are in distro's repository:
* qt5-default
* libqt5serialport5-dev
Expand All @@ -55,16 +55,16 @@ You will need the following packages, usually all of them are in distro's reposi
* libudev-dev
* if you are using Ubuntu: libappindicator-dev

####Build process:
#### Build process:
1. go to `<repo>/Software`
2. run ```qmake -r && make```
3. Add a rule for **UDEV**. See comments from `<repo>/Software/dist_linux/deb/etc/udev/rules.d/93-lightpack.rules` for how to do it.
4. Make sure `<repo>/Software/qtserialport/libQt5SerialPort.so.5` is available for loading by *Prismatik* (place it in appropriate dir or use *LD_LIBRARY_PATH* variable)

---

###Build instructions for OS X
####Prerequisites:
### Build instructions for OS X
#### Prerequisites:
* Qt SDK (5.0+)
* MacOSX 10.9.sdk

Expand All @@ -74,15 +74,15 @@ You will need the following packages, usually all of them are in distro's reposi
* QtNetwork.framework
* QtOpenGL.framework

####Build process:
#### Build process:
1. Download and unpack 5.0+ **Qt SDK** from www.qt-project.org
4. Build **Prismatik** project

to run Prismatik please make sure PythonQt libs are available for load at runtime

---

###Firmware build instructions
### Firmware build instructions
1. Install [AVR GCC Toolchain] (http://avr-eclipse.sourceforge.net/wiki/index.php/The_AVR_GCC_Toolchain)
2. Install **dfu-programmer** for firmware upload with `$ sudo apt-get install dfu-programmer`
3. Compile Prismatik using command line:
Expand Down