Skip to content

Commit

Permalink
docs: adding install instructions for app WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ssmirr committed Dec 16, 2020
1 parent 0e06e60 commit 27d3694
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
Binary file added docs/img/docable-tray-win-run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/docable-tray-win.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Installing and Running Docable Notebooks Tray app

Download and run the installer for your operating system from the links below:

- [Windows]()
- [macOS]()
- [Linux]()

After running the installer, you should be able to find the docable-tray app icon in your application list:

# Windows

Run the docable-tray app to start Docable Notebooks server in the background.

![docable tray windows app](img/docable-tray-win.png)

You can confirm the Docable Notebook has started successfully, by righ-clicking on the Docable icon in Windows Taskbar and clicking on "Open Docable...".

![docable tray windows app running](img/docable-tray-win-run.gif)

Your default browser should now open `http://localhost:3000/`.

# macOS

TODO.


# Updating

To update the docable-tray app, download and run the latest installers from [installation section]() above.

0 comments on commit 27d3694

Please sign in to comment.