-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from citharus/master
Updated README.md
- Loading branch information
Showing
1 changed file
with
84 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,109 @@ | ||
| <p align="center"><img src="https://cdn.oblivioncoding.pro/fluffy_board/AppLogo.png" height="200" alt="Logo"></p> | ||
|
|
||
| # Fluffyboard | ||
| <h1 align="center">Fluffyboard</h1> | ||
|
|
||
| Fluffyboard is a open source, free and self-hostable Whiteboard Application. | ||
| <p align="center">Fluffyboard is a open source, free and self-hostable Whiteboard Application</p> | ||
| <p align="center">Test the <a href="https://fluffyboard.obco.pro/">demonstration</a> of Fluffyboard</p> | ||
|
|
||
|  | ||
| ## Authors | ||
| <p align="center"> | ||
| <a href='https://play.google.com/store/apps/details?id=pro.oblivioncoding.fluffy_board&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'> | ||
| <img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png'/ height="100"> | ||
| </a> | ||
| </p> | ||
| <p align="center"> | ||
| <img src="https://img.shields.io/docker/cloud/automated/yonggan/fluffy_board-web" alt="Docker Cloud Automated build" heigt="50"> | ||
| <img src="https://img.shields.io/docker/cloud/build/yonggan/fluffy_board-web" alt="Docker Cloud Build Status" heigt="50"> | ||
| </p> | ||
|
|
||
| - [@Y0ngg4n](https://www.github.com/Y0ngg4n) | ||
| <h2>Table of Contents</h2> | ||
|
|
||
| <ol> | ||
| <li><a href="#Features">Features</a></li> | ||
| <li><a href="#Installation">Installation</a></li> | ||
| <li><a href="#Roadmap">Roadmap</a></li> | ||
| <li><a href="#Contributing">Contributing</a></li> | ||
| <li><a href="#License">License</a></li> | ||
| </ol> | ||
|
|
||
|
|
||
| ## Badges | ||
| <h2 id="Features">Features</h2> | ||
|
|
||
|  | ||
| <ul> | ||
| <li><i>Online</i> Whiteboards</li> | ||
| <li><i>Offline</i> Whiteboards</li> | ||
| <li>Downloading and Uploading Whiteboards</li> | ||
| <li>Import and Export Whiteboards</li> | ||
| <li>Organizing Whiteboards in Folders</li> | ||
| <li>Sharing online Whiteboards with readonly and write Permissions</li> | ||
| <li>Drawing lines</li> | ||
| <li>Highlighting</li> | ||
| <li>Drawing Straight Lines and Arrows</li> | ||
| <li>Drawing Rects, Triangles and Circles</li> | ||
| <li>Adding Text</li> | ||
| <li>Uploading Images</li> | ||
| <li>Importing PDF</li> | ||
| <li>Changing Background</li> | ||
| <li>Settings sync</li> | ||
| <li>Adding bookmarks</li> | ||
| <li>Changing Toolbar location</li> | ||
| </ul> | ||
|
|
||
|  | ||
|
|
||
| <a href='https://play.google.com/store/apps/details?id=pro.oblivioncoding.fluffy_board&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png'/></a> | ||
| ## Demo | ||
|
|
||
| Demonstation can be found on dev instance of [Fluffyboard](https://fluffyboard.obco.pro) | ||
| <h2 id="Installation">Installation</h2> | ||
|
|
||
|
|
||
| ## Roadmap | ||
| ### Web instance | ||
|
|
||
| Checkout the Github Project: https://github.com/Y0ngg4n/fluffy_board/projects/2 | ||
| For the <a href="https://hub.docker.com/repository/docker/yonggan/fluffy_board-web/">Docker image</a> see more on DockerHub. | ||
|
|
||
|
|
||
| ## Features | ||
| To set up your own web instance visit the <a href="Repository">Fluffy REST API Repository</a>. | ||
|
|
||
| - Online Whiteboards | ||
| - Offline Whiteboards | ||
| - Downloading and Uploading Whiteboards | ||
| - Import and export Whiteboards | ||
| - Organizing Whiteboards in Folders | ||
| - Sharing online Whiteboards with readonly and write Permissions | ||
| - Drawing lines | ||
| - Highlighting | ||
| - Drawing Straight Lines and Arrows | ||
| - Drawing Rects, Triangles and Circles | ||
| - Adding Text | ||
| - Uploading Images | ||
| - Importing PDF | ||
| - Changing Background | ||
| - Settings sync | ||
| - Adding bookmarks | ||
| - Changing Toolbar location | ||
| ## Installation | ||
| ### Web | ||
| You can find the Web Version on Dockerhub [yonggan/fluffy_board-web](https://hub.docker.com/repository/docker/yonggan/fluffy_board-web/) | ||
| ### Windows | ||
|
|
||
| You can use the https://github.com/Y0ngg4n/fluffy_rest_api Repository to set up your own instance. | ||
| Download the `Fluffyboard-windows.zip` from the <a href="https://github.com/Y0ngg4n/fluffy_board/releases">latest Release</a>. | ||
|
|
||
| ### Windows | ||
| - Download the zip Files from [Releases](https://github.com/Y0ngg4n/fluffy_board/releases). | ||
| - Extract it | ||
| - Execute the `.exe` File | ||
| Extract the zip archive and place it's contents in the folder of your choice. | ||
|
|
||
| ### Linux | ||
| - Download the zip Files from [Releases](https://github.com/Y0ngg4n/fluffy_board/releases). | ||
| - Extract it | ||
| - Give it the Permission to get executed: `chmod 755 fluffy_board` | ||
| - Execute it | ||
|
|
||
| ### Android | ||
| You can donload the App from [Google Play Store](https://play.google.com/store/apps/details?id=pro.oblivioncoding.fluffy_board). | ||
| Apk Builds are currently not working. | ||
| I am working on an Fdroid Release. | ||
| Download the `Fluffyboard-linux.zip` from the <a href="https://github.com/Y0ngg4n/fluffy_board/releases">latest Release</a>. | ||
|
|
||
| Extract the zip archive and and place it's contents in the folder of your choice. | ||
|
|
||
| Give the executable the required permissions. | ||
|
|
||
| ```terminal | ||
| chmod +x fluffy_board | ||
| ``` | ||
|
|
||
| Create a *symbolic link* to the executable in `/usr/local/bin/`. | ||
|
|
||
| ```sh | ||
| sudo ln -s /home/USERNAME/PATH/TO/EXECUTABLE /usr/local/bin/fluffyboard | ||
| ``` | ||
|
|
||
| ### macOS | ||
|
|
||
| ### MacOS | ||
| - Download the zip Files from [Releases](https://github.com/Y0ngg4n/fluffy_board/releases). | ||
| - Extract it | ||
| - Give it the Permission to get executed: `chmod 755 fluffy_board.app` | ||
| - Double click in Finder | ||
| Download the `Fluffyboard-mac.zip` from the <a href="https://github.com/Y0ngg4n/fluffy_board/releases">latest Release</a>. | ||
|
|
||
| ### IOS | ||
| Coming soon | ||
| Extract the zip archive and and place it's contents in the folder of your choice. | ||
|
|
||
| ## Contributing | ||
| Give the executable the required permissions. | ||
|
|
||
| ```sh | ||
| chmod +x fluffy_board.app | ||
| ``` | ||
|
|
||
| You can now find ***Fluffyboard*** in `Finder`. | ||
|
|
||
| <h2 id="Roadmap">Roadmap</h2> | ||
|
|
||
| You can find the <a href="https://github.com/Y0ngg4n/fluffy_board/projects/2">current roadmap</a> in `Projects`. | ||
|
|
||
| <h2 id="Contributing">Contributing</h2> | ||
|
|
||
| Contributions are always welcome! | ||
|
|
||
|
|
||
| <h2 id="License">License</h2> | ||
|
|
||
| ***Fluffyboard*** is licensed under the <a href="GNU General Public License v3.0">GNU General Public License v3.0</a>. | ||
|
|