Skip to content

Commit

Permalink
add beta changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeDoctorDE committed Oct 15, 2021
1 parent 5286409 commit 3004068
Show file tree
Hide file tree
Showing 18 changed files with 279 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/src/pages/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Changelog

## 1.0.0-beta.0

* Add new color picker
* Multiple palettes
* Open/save palettes
* Custom colors
* Edit palettes
* Add new label properties (font weight, italic, decoration)
* Fix shared preferences bug that prevents starting the app on android

## 1.0.0-alpha.0

First release 🎉
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label":"Background"
}
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/background/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_label: Introduction
---

# Background

You can customize the background of the paper.
Click on the background icon in the view tool to add it.

## Configuration

Width and height are the general settings of the box.
Space and count are important if you want to add a complex structure.
See [the music paper](./music) for more. Set this to 1 on x or/and y to let the lines rendered.

Additionally you can customize the color of the background.
12 changes: 12 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/background/music.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Music paper

| Property | Value |
| -------: | :---- |
| Width | 200 |
| Height | 5 |
| Count X | 1 |
| Count Y | 5 |
| Space X | 10 |
| Space Y | 60 |

See [the introduction](intro) for more information.
12 changes: 12 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/background/quad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Quad paper

| Property | Value |
| -------: | :---- |
| Width | 15 |
| Height | 15 |
| Count X | 1 |
| Count Y | 1 |
| Space X | 0 |
| Space Y | 0 |

See [the introduction](intro) for more information.
12 changes: 12 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/background/ruled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Ruled paper

| Property | Value |
| -------: | :---- |
| Width | 0 |
| Height | 25 |
| Count X | 0 |
| Count Y | 1 |
| Space X | 0 |
| Space Y | 0 |

See [the introduction](intro) for more information.
13 changes: 13 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/color_picker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Color picker
---

![Color picker](/img/tutorial/color_picker.png)

* Open, save the dialog to access it in other documents
* Reset the palette for the default material palette
* Add, remove and edit the name of the palette
* Add new colors by clicking on the plus button in the bottom
* Edit the colors by long clicking on the color

You can access the color picker on the view tool by clicking on the color button.
39 changes: 39 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
sidebar_position: 1
---

# Introduction

![Banner](/img/banner.png)

---

> Welcome to Butterfly, the opensource note app.
> Use the sidebar to navigate through the wiki.
## Getting started

Visit [the downloads](/downloads) to download the app for your platform.
Use [web version](https://butterfly.linwood.dev) if you cannot find your platform.

![Home page](/img/tutorial/home.png)

Then you can open the app. On the screen you can see all documents you can edit. On the first start it should be empty.
To open a file, use the open button in the right corner. The settings button is also there.
Create a document by clicking on the bottom right plus icon. Give the document a name.
Click oo the document to open it.

## Main view

![Main view](/img/tutorial/main.png)

With the top left button you can go back to the document list.
The document name will be displayed on the right of it.
Undo, redo and project settings are on the top right corner.

Below it, you can find the toolbar. Left, you can switch between view and edit mode.
Right to it, there you find the zoom options.
In the top right corner there are the tool options.

- The view toolbar options are background, export and save.
- The edit toolbar options are the painters. You can find [here](background/intro) more.
10 changes: 10 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/migrating.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Migrating
---

This guide will show you how to migrate to the latest version.

## 1.0.0-beta.0

This works automatically.
To add the default color palette, simply click on the reset button in the color dialog.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label":"Painters"
}
15 changes: 15 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/painters/eraser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_label: Eraser
sidebar_position: 3
---

# Eraser painter

With this painter you can erase the elements on the paper.

## Configuration

| Property | Default | Description |
| ----------------: | :-----: | :------------------------------------------------------------------------------- |
| Stroke width | 5 | The width of the stroke |
| Stroke multiplier | 1 | If you have a stylus, this is the multiplier which will be added to the pressure |
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/painters/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 1
sidebar_label: Introduction
---

# Painters

Painters can edit the paper.
You can find it in the edit tool in the bottom right corner.

Use the sidebar to learn more about the painters.

Create a new painter by clicking on the plus icon. Change the painter order by dragging and change the painter by clicking.
If you click on a selected tool you can configure the painter.

The name of the painter will be displayed as tooltip on hover on the painter.
14 changes: 14 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/painters/label.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_label: Label
sidebar_position: 5
---

# Label painter

With this painter you can add text to the paper.

## Configuration

| Property | Default | Description |
| -------: | :-----: | :------------------- |
| Size | 12 | The size of the text |
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/painters/path_eraser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_label: Path eraser
sidebar_position: 4
---

# Path eraser painter

With this painter you can delete the whole path on the paper.

## Configuration

| Property | Default | Description |
| ----------------: | :-----: | :-------------------------------------------------------------------------------------------------------------- |
| Stroke width | 5 | The width of the stroke |
| Stroke multiplier | 1 | If you have a stylus, this is the multiplier which will be added to the pressure |
| Can delete eraser | false | This setting controls if you can remove the path of the eraser. The path under the removed eraser will be shown |
16 changes: 16 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/painters/pen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_label: Pen
sidebar_position: 2
---

# Pen painter

With this painter you can draw on this paper.

## Configuration

| Property | Default | Description |
| ----------------: | :-----: | :------------------------------------------------------------------------------- |
| Color | Black | The color that will be drawn |
| Stroke width | 5 | The width of the stroke |
| Stroke multiplier | 1 | If you have a stylus, this is the multiplier which will be added to the pressure |
63 changes: 63 additions & 0 deletions docs/versioned_docs/version-1.0.0-beta.0/privacypolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Privacy Policy
---


CodeDoctor built the Butterfly app as an Open Source app. This SERVICE is provided by CodeDoctor at no cost and is intended for use as is.

This page is used to inform visitors regarding my policies with the collection, use, and disclosure of Personal Information if anyone decided to use my Service.

If you choose to use my Service, then you agree to the collection and use of information in relation to this policy. The Personal Information that I collect is used for providing and improving the Service. I will not use or share your information with anyone except as described in this Privacy Policy.

The terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, which is accessible at Butterfly unless otherwise defined in this Privacy Policy.

**Information Collection and Use**

For a better experience, while using our Service, I may require you to provide us with certain personally identifiable information. The information that I request will be retained on your device and is not collected by me in any way.

The app does use third party services that may collect information used to identify you.

Link to privacy policy of third party service providers used by the app

* [Google Play Services](https://www.google.com/policies/privacy/)

**Log Data**

I want to inform you that whenever you use my Service, in a case of an error in the app I collect data and information (through third party products) on your phone called Log Data. This Log Data may include information such as your device Internet Protocol (“IP”) address, device name, operating system version, the configuration of the app when utilizing my Service, the time and date of your use of the Service, and other statistics.

**Cookies**

Cookies are files with a small amount of data that are commonly used as anonymous unique identifiers. These are sent to your browser from the websites that you visit and are stored on your device's internal memory.

This Service does not use these “cookies” explicitly. However, the app may use third party code and libraries that use “cookies” to collect information and improve their services. You have the option to either accept or refuse these cookies and know when a cookie is being sent to your device. If you choose to refuse our cookies, you may not be able to use some portions of this Service.

**Service Providers**

I may employ third-party companies and individuals due to the following reasons:

* To facilitate our Service;
* To provide the Service on our behalf;
* To perform Service-related services; or
* To assist us in analyzing how our Service is used.

I want to inform users of this Service that these third parties have access to your Personal Information. The reason is to perform the tasks assigned to them on our behalf. However, they are obligated not to disclose or use the information for any other purpose.

**Security**

I value your trust in providing us your Personal Information, thus we are striving to use commercially acceptable means of protecting it. But remember that no method of transmission over the internet, or method of electronic storage is 100% secure and reliable, and I cannot guarantee its absolute security.

**Links to Other Sites**

This Service may contain links to other sites. If you click on a third-party link, you will be directed to that site. Note that these external sites are not operated by me. Therefore, I strongly advise you to review the Privacy Policy of these websites. I have no control over and assume no responsibility for the content, privacy policies, or practices of any third-party sites or services.

**Changes to This Privacy Policy**

I may update our Privacy Policy from time to time. Thus, you are advised to review this page periodically for any changes. I will notify you of any changes by posting the new Privacy Policy on this page.

This policy is effective as of 2021-02-07

**Contact Us**

If you have any questions or suggestions about my Privacy Policy, do not hesitate to contact me at [email protected].

This privacy policy page was created at [privacypolicytemplate.net](https://privacypolicytemplate.net) and modified/generated by [App Privacy Policy Generator](https://app-privacy-policy-generator.nisrulz.com/)
8 changes: 8 additions & 0 deletions docs/versioned_sidebars/version-1.0.0-beta.0-sidebars.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"version-1.0.0-beta.0/tutorialSidebar": [
{
"type": "autogenerated",
"dirName": "."
}
]
}
1 change: 1 addition & 0 deletions docs/versions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[
"1.0.0-beta.0",
"1.0.0-alpha.0"
]

2 comments on commit 3004068

@vercel
Copy link

@vercel vercel bot commented on 3004068 Oct 15, 2021

Choose a reason for hiding this comment

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

@vercel
Copy link

@vercel vercel bot commented on 3004068 Oct 15, 2021

Choose a reason for hiding this comment

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

Please sign in to comment.