Skip to content

Commit

Permalink
Merge branch 'master' of github.com:idyll-lang/idyll-desktop
Browse files Browse the repository at this point in the history
* 'master' of github.com:idyll-lang/idyll-desktop:
  Update README.md
  Update USER_GUIDE.md
  Update USER_GUIDE.md
  Update README.md
  • Loading branch information
mathisonian committed Feb 16, 2021
2 parents b92e823 + 8faa7a8 commit 53fb0a9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 43 deletions.
35 changes: 1 addition & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[Work in Progress]

# Idyll Studio

Sketches towards an integrated dynamic publishing application.
Toward an integrated interactive publishing engine.

# USAGE GUIDE
See [USER_GUIDE.md](./USER_GUIDE.md)
Expand All @@ -11,34 +9,3 @@ See [USER_GUIDE.md](./USER_GUIDE.md)

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Mockup

_Note: The mocks are slightly out of date, as we now use tabs in the sidebar rather than listing variables components and datasets all in one view_

**Overview**

![Overview](./mocks/Overview.png)

**Annotations**
![Annotations](./mocks/Annotations.png)

**Text 1**
![Text](./mocks/text-edit-selection.png)

**Text 2**
![Text](./mocks/text-edit-inline.png)

**Adding component 1**
![Component](./mocks/component-add-inline.png)

**Adding component 2**
![Component](./mocks/component-add.png)

**Custom component**
![Custom](./mocks/custom-component-select.png)

**Selecting a component**
![Component](./mocks/component-select.png)

**Component hover**
![Component](./mocks/component-hover.png)
18 changes: 9 additions & 9 deletions USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@ This project is a work in progress. Use at risk of frustration.

*...install it?*

Clone the repo and install the dependencies. [More details.](./CONTRIBUTING.md).
To install the latest release, navigate to the [releases](https://github.com/idyll-lang/idyll-studio/releases) page, and install the application for your operating system. If you are on a Mac, choose the one with "darwin" in the name. Currently Mac, Windows, and Linux (.deb and .rpm) are supported.

If you wish to install from source, clone the repo and install the dependencies. [More details](./CONTRIBUTING.md).

*...run it?*

Run `yarn start` (or `npm start`).
Click the app icon to start the application.

If you are using the command line version, run `yarn start` (or `npm start`).


*...make a new project?*

At this point you can't. You have to use the command line [idyll](https://github.com/idyll-lang/idyll) tool to generate one, and then load it via this project.
From the app home screen, choose "create new project." If you have an existing project open already, choose "File -> New" from the application menu.

*...load a project?*

Expand All @@ -29,13 +33,9 @@ Hit the "select" button on the loading page. Navigate to an idyll project, and s

Navigate to the `Component` panel. Drag and drop a component onto the article. A black rectangle will appear when it is in a valid location. [<span color="red">Not all components function in thir default configuration currently.</span>]

*...modify a component's property?*

Click the component's properties button. Click the property. Use the text input field to change the property. [<span color="red">Bug in the current release.</span>]

*...add a property to a component?*
*...modify a component's properties?*

Use code button to modify the Idyll code representing the component direction. Edit the idyll markup. Click the code button again for the change to take effect.
Click the component's properties button (gear icon). Click the property. Use the text input field to change the property.

*...create a variable?*

Expand Down

0 comments on commit 53fb0a9

Please sign in to comment.