Skip to content

Commit

Permalink
Merge branch 'pre-push'
Browse files Browse the repository at this point in the history
  • Loading branch information
Zolindo committed Jun 11, 2024
2 parents 1885282 + bb13434 commit a633838
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 4 deletions.
3 changes: 3 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ export default defineConfig({
title: "RT Sheet Editor",
description: "Documentation",
base: '/Rhythm-Sheet-Editor-Doc/',
head: [
['link', { rel: 'icon', href: './docs/public/Logo.png' }]
],
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
Expand Down
3 changes: 0 additions & 3 deletions docs/Getting-stardet.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## Step 1: Install RT Sheet Editor

RT Sheet Editor is available for all major operating systems, including the latest versions of Windows, macOS, and Linux. To download RT Sheet Editor

The installation instructions depend on the operating system.

### Windows:
Expand All @@ -23,9 +22,7 @@ Make the AppImage file executable by typing .chmod a+x RT-Sheet-Editor*.AppImage
## Step 2: Create a new project

1. Launch RT Sheet Editor.

2. Either click on **New project** to start from an empty project.

3. Choose a location and name for the project, and audio file to start a new project.


Expand Down
55 changes: 54 additions & 1 deletion docs/Guides/6.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,57 @@ To export a JSON file from the RT sheet editor, follow these steps:
- Choose the location on your computer where you want to save the JSON file.

5. **Confirm the Export**:
- After naming your file and selecting the save location, click the confirmation button, often labeled "Export" or "Save"

- After naming your file and selecting the save location, click the confirmation button, often labeled "Export" or "Save".


::: details This is how the export file looks :
```json
{
"Channels": {
"Main Sheet": {
"BPM": 124, // BPM of this sheet
"EventKeys": [ // Array containing all event keys
{
"Duration": 0,
"Time": 1.33,
"Event": "left"
},
{
"Duration": 0,
"Time": 1.572,
"Event": "right"
},
{
"Duration": 0,
"Time": 1.572,
"Event": "right"
},
{
"Duration": 0,
"Time": 1.693,
"Event": "up"
}
]
},
"Second Sheet": {
"BPM": 62,
"EventKeys": [
{
"Duration": 0.725,
"Time": 1.209,
"Event": "Row 1"
},
{
"Duration": 0.725,
"Time": 1.209,
"Event": "Row 4"
}
]
}
},
"Duration": 264.603 // Music duration
}
```
:::

0 comments on commit a633838

Please sign in to comment.