picnoir / ultimate-writer

Open Digital Typewriter
GNU General Public License v3.0
295 stars 16 forks source link

Ultimate Writer

Picture of the Ultimate Writer Prototype

Ultimate writer is an attempt to create the perfect digital writing device; it may also be a clickbaity name, who knows.

It was built upon the following principles:

My ultimate writing device is probably not your ultimate writing device. However, I think we can share a common codebase.

This repo is hosting this codebase.

Part List

Depending on where you buy those part and how much time you spend sourcing them, the final price tag will range between 100 and 200€ (half the price of a freewrite.

Build and Install

First, install raspbian on your raspberrypi.

Then, install the necessary dependencies:

  1. Download and install bcm2835.
  2. Enable SPI on your raspberry pi.
  3. Build and Install logkeys.

Then, open a terminal on the raspberry pi and build ultimate writer:

sudo apt-get install build-essential git
git clone $GITHUB_URL && cd ultimate-writer
make
sudo make install

Note: The current master branch could be broken, please, use the latest release tag.

If, for some reason, you want to uninstall this software:

sudo make uninstall

You can then start the ultimate writer service. This service will display a root shell on the e-ink screen:

sudo systemctl start ultimatewriter

If you want the service to automatically start on boot:

sudo systemctl enable ultimatewriter

Troubleshooting

Open an issue on this GitHub repo.

Contributing

Contributions are more than welcome.

If you build one of these, it'll make me very happy to see your finished work, send me an e-mail :).

If enough people build this kind of device, we'll create a website listing the various case designs.

In order to contribute:

  1. Open a GitHub issue.
  2. Fork the project.
  3. Send a PR to this repo's master branch.

Roadmap

This project is not fully done yet, we would like to implement:

Special Thanks