Skip to content
This repository has been archived by the owner on Aug 28, 2021. It is now read-only.

Commit

Permalink
Merge pull request #34 from speckleworks/Matteo/dev
Browse files Browse the repository at this point in the history
Matteo/dev
  • Loading branch information
teocomi authored Feb 5, 2020
2 parents a289337 + 476e341 commit cccc656
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 22 deletions.
5 changes: 5 additions & 0 deletions components/toolbar.vue
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ export default {
link: "/about",
local: true
},
{
name: "Admin",
link: "https://app.speckle.systems",
local: false
},
{
name: "Github",
link: "https://github.com/speckleworks",
Expand Down
46 changes: 28 additions & 18 deletions pages/docs/essentials/start.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,50 @@ order: 1
<template lang='md'>

<!-- ![clients](~/assets/docs/various/screenshots.png) -->
# 1. Register {.font-weight-thin .display-1 .my-4}

# 1. Download {.font-weight-thin .display-1 .my-4}
To use Speckle you'll need a Speckle server and an account on that server. If you or your company don't have <a href="/docs/developers/deploy-server">deployed your own</a>, you can just use the "community server", hestia.

In order to use speckle, you will need to have some authoring software installed on your computer. We currently have integrations for **Grasshopper, Dynamo, Rhino, and Revit (early alpha!)** - either of those should do. It also helps to have a friend next to you, as it's much more fun to send data to each other rather than play ping-pong alone!
The address of hestia is:

<!-- ### The Speckle Clients Installer {.font-weight-thin-xx .my-4} -->
```js

<!-- <v-alert :value='true' class='my-4' color='primary'> -->
<div class='text-xs-center my-4'>
"https://hestia.speckle.works"
```
<v-alert type='warning' :value='true' class='my-4' color='primary'>
Please be aware that the test server, Hestia, comes with absolutely no guarantees of any sort. While it has had stellar uptime record so far, please do not rely on it for anything remotely important!
</v-alert>

<p></p>
Server sorted, you can use the always-up-to-date Speckle admin web app to register a new account, or you can do so also when using the clients for the first time (see below).


<div class='text-xs-center my-4'>
<v-btn color='primary' round large href='https://github.com/speckleworks/SpeckleInstaller/releases/latest' target="_blank">
download speckle clients <v-icon right>arrow_right_alt</v-icon>
Speckle Admin <v-icon right>arrow_right_alt</v-icon>
</v-btn>
</div>
<!-- </v-alert> -->

<!-- ### Getting Started Guides {.font-weight-thin-xx .my-4} -->

You will need to download and run the `SpeckleInstaller.exe` file from the link above. This will install the latest release of the clients and once it is succesful, you should be able to open the speckle plugins from the software you've installed it for.

# 2. Register {.font-weight-thin .display-1 .my-4}

When you first use Speckle you will be prompted to create an account with a speckle server.
# 2. Download {.font-weight-thin .display-1 .my-4}

To send data via Speckle, you will need to have some authoring/analysis software installed on your computer. We currently have integrations for **Grasshopper, Dynamo, Rhino, GSA, Blender, Revit (beta) and Excel (beta)** - either of those should do. It also helps to have a friend next to you, as it's much more fun to send data to each other rather than play ping-pong alone!

Speckle can be deployed by anybody anywhere they want. Hence, there's no single Speckle where you can register an account; perhaps your company already runs a server - ask around! Nevertheless, in case you just want to test things out, you can register with the "community server", hestia.
<!-- ### The Speckle Clients Installer {.font-weight-thin-xx .my-4} -->

```js
<!-- <v-alert :value='true' class='my-4' color='primary'> -->
<div class='text-xs-center my-4'>
<v-btn color='primary' round large href='https://github.com/speckleworks/SpeckleInstaller/releases/latest' target="_blank">
download speckle clients <v-icon right>arrow_right_alt</v-icon>
</v-btn>
</div>
<!-- </v-alert> -->

"https://hestia.speckle.works"
```
<!-- ### Getting Started Guides {.font-weight-thin-xx .my-4} -->

<v-alert type='warning' :value='true' class='my-4' color='primary'>
Please be aware that the test server, Hestia, comes with absolutely no guarantees of any sort. While it has had stellar uptime record so far, please do not rely on it for anything remotely important!
</v-alert>
You will need to download and run the `SpeckleInstaller.exe` file from the link above. This will install the latest release of the clients and once it is succesful, you should be able to open the speckle plugins from the software you've installed it for.

# 3. Read The Docs {.font-weight-thin .display-1 .my-4}

Expand Down
4 changes: 2 additions & 2 deletions pages/docs/web/management.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ order: 0

<br>

This interface is called Speckle admin, and it can be found usually at the root of your Speckle server address. If you have a test account on the Hestia server, you can find it here:
This interface is called Speckle admin, and it can be found usually at the root of your Speckle server address. There is also an always-up-to-date Speckle admin web app that you can use with any Speckle server (if accessible and with https):

<div class='text-xs-center my-4'>
<v-btn color='primary' round href='https://hestia.speckle.works' target="_blank">
<v-btn color='primary' round href='https://app.speckle.systems' target="_blank">
Speckle Admin <v-icon right>arrow_right_alt</v-icon>
</v-btn>
</div>
Expand Down
4 changes: 2 additions & 2 deletions pages/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
a fast, web-scale base for automation in design, engineering and construction.
</h2>
<br>
<v-btn large round color='primary' class='mt-5' @click="$vuetify.goTo('#features')">Read more</v-btn>
<v-btn large flat round small color='primary' class='mt-5' to='/docs/essentials/start'>Getting Started</v-btn>
<!-- <v-btn large round color='primary' class='mt-5' @click="$vuetify.goTo('#features')">Read more</v-btn> -->
<v-btn large round small color='primary' class='mt-5' to='/docs/essentials/start'>Get Started</v-btn>
<v-btn large flat round small color='primary' class='mt-5' href='https://github.com/speckleworks' target='_blank'>Github <v-icon right>arrow_right_alt</v-icon>
</v-btn>
</v-flex>
Expand Down

0 comments on commit cccc656

Please sign in to comment.