Skip to content

Commit

Permalink
🦊 Fix #72
Browse files Browse the repository at this point in the history
  • Loading branch information
@fonsp
fonsp committed Apr 24, 2020
1 parent 41ee210 commit 7332320
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 25 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "Pluto"
uuid = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
license = "MIT"
authors = ["Fons van der Plas <[email protected]>", "Mikołaj Bochenski <[email protected]>"]
version = "0.7.4"
version = "0.7.5"

[deps]
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
Expand Down
29 changes: 23 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,24 @@ Your notebooks are saved as pure Julia files, which you can then import as if yo

<img alt="formatting screenshot" src="demo/formatting.png" width="50%">

## Installation
## Let's do it!

_(To developers: follow [these instructions](https://github.com/fonsp/Pluto.jl/blob/master/dev_instructions.md) to start working on the package.)_
### Ingredients
For one tasty notebook 🥞 you will need:
- **Julia** v1.0 or above
- **Linux**, **macOS** or **Windows**, _Linux and macOS will work best_
- Mozilla **Firefox** or Google **Chrome**, be sure to get the **latest** version

After [installing julia](https://julialang.org/), add the package:
### Installation

Run Julia and add the package:
```julia
julia> ]
(v1.0) pkg> add Pluto
```

_Adding the first package to Julia can take up to 30 minutes - hang in there!_

To run the notebook server:
```julia
julia> using Pluto
Expand All @@ -42,13 +50,22 @@ julia> Pluto.run(1234)

Then go to [`http://localhost:1234/`](http://localhost:1234/) to start coding!

**Work remotely**:
You can also run Pluto _on a server_, and use the browser on your own computer as user interface. For this, you need to set up an _SSH tunnel_. First, log in to your server using SSH and start a Pluto server. Then open a local terminal on your own computer and type:

```bash
ssh user@ipaddress -LN 1234:localhost:1234
```
with `user` and `ipaddress` filled in accordingly. You can then go to [`http://localhost:1234/`](http://localhost:1234/) on your own computer to get started! For more info and instructions for Windows, see [this guide](https://medium.com/@apbetahouse45/how-to-run-jupyter-notebooks-on-remote-server-part-1-ssh-a2be0232c533).

**To developers**:
Follow [these instructions](https://github.com/fonsp/Pluto.jl/blob/master/dev_instructions.md) to start working on the package.

<img alt="plotting screencap" src="demo/plutoODE.gif" >

## Note

This package is still in its early days - go to the [issue tracker](https://github.com/fonsp/Pluto.jl/issues) to see what's up!

Let us know what you think! 😊
We are happy to say that **Pluto.jl is in a stable state**, and we look forward to hearing what you think! 😊

This comment has been minimized.

Sign in to view

Copy link
@vdplasthijs

vdplasthijs Apr 28, 2020

👍 😄

<img alt="feedback screencap" src="https://user-images.githubusercontent.com/6933510/78135402-22d02d80-7422-11ea-900f-a8b01bdbd8d3.png" >

Expand Down
14 changes: 7 additions & 7 deletions assets/editor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -600,13 +600,13 @@
</style>

<script src="https://cdn.jsdelivr.net/npm/@observablehq/[email protected]/dist/stdlib.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/mode/julia/julia.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/display/placeholder.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/edit/matchbrackets.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.css"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/mode/julia/julia.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/display/placeholder.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/edit/matchbrackets.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.css"></script>

<link rel="stylesheet" href="/assets/light.css" />
<!-- The instant feedback form at the bottom of the page uses Google Firestore to save feedback. We DO NOT use Google Analytics, and NO DATA is sent except for data entered in the feedback form. We might add telemetry in the future, and this will be an opt-in feature. -->
Expand Down
1 change: 0 additions & 1 deletion assets/filepicker.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ function createCodeMirrorFilepicker(placer, onEnter, reset, suggestNewFile) {

editor.on("change", (cm, change) => {
requestPathCompletions(cm)
cm.scrollIntoView()
})

return editor
Expand Down
10 changes: 5 additions & 5 deletions assets/sample.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
<script src="/assets/client.js"></script>
<script src="/assets/filepicker.js"></script>

<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/display/placeholder.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.css">
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/display/placeholder.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.css">

<link rel="stylesheet" href="/assets/welcome.css">

Expand Down
10 changes: 5 additions & 5 deletions assets/welcome.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
<script src="/assets/client.js"></script>
<script src="/assets/filepicker.js"></script>

<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/display/placeholder.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.50.0/addon/hint/show-hint.min.css"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/display/placeholder.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/lib/codemirror.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/codemirror@5.53.2/addon/hint/show-hint.min.css"></script>

<link rel="stylesheet" href="/assets/welcome.css">

Expand Down

3 comments on commit 7332320

@fonsp
Copy link
Owner Author

@fonsp fonsp commented on 7332320 Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/13587

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.5 -m "<description of version>" 73323206737f5f68ef3aeb9cac6c5410048620f8
git push origin v0.7.5

@fonsp
Copy link
Owner Author

@fonsp fonsp commented on 7332320 Apr 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#72

Please sign in to comment.