Skip to content

Commit

Permalink
Merge pull request #77 from SkwalExe/docs
Browse files Browse the repository at this point in the history
Add general presentation page to documentation
SkwalExe authored Aug 4, 2024
2 parents a983cfb + ed9167e commit 097b03b
Showing 3 changed files with 39 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -32,6 +32,12 @@ export default defineConfig({
{ text: '📥 Getting Started', link: '/getting-started' },
{ text: '🌟 Screenshots', link: '/screenshots' }
]
},
{
text: 'Guides',
items: [
{ text: '💎 General Presentation', link: '/presentation' },
]
}
],

Binary file added docs/src/help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/src/presentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# General Presentation 💎 {#general-presentation}

Fractalistic aims to be as intuitive and easy to use as possible. Despite its complexity, navigating the interface is very straightforward. This section will guide you through the basic functions to help you get started quickly.


### The components 🪟 {#the-components}

Fractalistic provides **3 components** that you can interact with after opening the application.
- 🖼️ The canvas
- 📜 the logs panel
- ⌨️ and the command input.

You must focus a component to interact with it. By default, **the canvas is active** (as indicated by the blue border), but you can select the logs panel or the command input either with **a mouse click**, or by **pressing tab.**


![Banner](https://raw.githubusercontent.com/SkwalExe/fractalistic/main/assets/banner.png)


### The canvas 🖼️ {#the-canvas}

When focused, the canvas listens for keypresses that will trigger an action. For example, using the arrow keys will allow you to navigate within the current fractal. The canvas usage and basic navigation will be covered in a future section.

### The logs panel 📜 {#the-logs-panel}

The logs panel is where the commands output will be displayed. You can use the mouse, the scroll bar, or the keyboard keys to scroll through the logs.

### The command input ⌨️ {#the-command-input}

The command input feature enables you to interact with the application, allowing for **more complex actions** beyond basic navigation.

Details on how to use the command system will be provided in a later section. If you are curious, you can run the `help` or `help +` commands to get an overview of the available commands!

![help command](./help.png)

0 comments on commit 097b03b

Please sign in to comment.