Skip to content

Commit

Permalink
Docs + Format action
Browse files Browse the repository at this point in the history
  • Loading branch information
dimkauzh committed Jul 22, 2024
1 parent eed74e5 commit 393290e
Show file tree
Hide file tree
Showing 6 changed files with 73 additions and 27 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.21'
go-version: '1.22'

- name: Update Packages (Linux)
if: startsWith(matrix.os, 'ubuntu')
Expand Down
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,8 @@ format:
go fmt ./internal/windowing/wayland/
go fmt ./internal/windowing/

go fmt ./examples/images/
go fmt ./examples/rectangle/
go fmt ./examples/two-windows/
go fmt ./examples/basic-window/

7 changes: 5 additions & 2 deletions website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Welcome to the documentation of Vuelto! Here you will find a wiki, which is basically all function explained. New to Vuelto? Then head over to the [tutorials tab](../tutorials/index.md) in the navigation bar.

To start with, make sure you have everything setup and Vuelto ready to use. If you are not sure that you have everything setup, head over to the [Get Started tab](../get-started.md) in the navigation bar.
## 📑 Table of contents
- [Latest stable docs](latest/windowing.md)
- [Developers and contributors](developers/index.md)



For Vuelto's roadmap (to see which features are coming soon), head over to the [Roadmap tab](../roadmap/v1.md) in the navigation bar.
2 changes: 1 addition & 1 deletion website/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We have a [discord server at this link](https://discord.gg/gZqdRXbbqg). It's a f
We are fully open to contributions, but I will check and test your code before merging it into the dev branch. All your code thats accepted will only be merged into the dev branch, and will be later released with the next release.

## 🔐 License
Vuelto is licensed under the [GPLv3 Licence](LICENSE). Any PR's that go mainly about changing the licence won't be accepted.
Vuelto is licensed under the [GPLv3 Licence](https://github.com/vuelto-org/vuelto/blob/latest/LICENSE.md). Any PR's that go mainly about changing the licence won't be accepted.

<h2 style="text-align: center;">Made for you by the Vuelto Team ❤️ </h2>

47 changes: 40 additions & 7 deletions website/roadmap/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,42 @@
- [x] GoDoc

## V1.1
- [ ] Web
- [ ] Web-windowing
- [ ] Support for web using wasm

- [ ] Web-rendering
- [ ] Support for buildin graphics driver
- [ ] WebGL
- [ ] Renderer
- [ ] SetPixel
- [ ] LoadText and .Draw()
- [ ] Web
- [ ] Web-windowing
- [ ] Support for web using wasm
- [ ] Web-rendering
- [ ] Support for buildin graphics driver
- [ ] WebGL
- [ ] Desktop
- [ ] Move to OpenGL v3.3

- [ ] 2 Ring Rendering Driver
- [ ] Ring 1
- [ ] Wrapper around OpenGL C api
- [ ] Wrapper around WebGL JS api
- [ ] Ring 2
- [ ] API around OpenGL and WebGL

- [ ] Input
- [ ] Keyboard
- [ ] Mouse

- [ ] Website
- [ ] Docs
- [ ] Vuelto Docs
- [ ] Vuelto API
- [ ] How to use vuelto
- [ ] Vuelto's functionality
- [ ] Developer Docs
- [ ] Vuelto's 3 ring structure
- [ ] CONTRIBUTING.md
- [ ] Tutorials
- [ ] Examples
- [ ] Tutorials to build small games

## V1.2
- [ ] Renderer
- [ ] SetPixel
Expand All @@ -59,9 +83,18 @@
- [ ] Usable with animations

- [ ] Node system
- [ ] Movable nodes
- [ ] Custom physics option
- [ ] Static nodes
- [ ] Unmovable
- [ ] Just a basic image/shape

- [ ] Animations
- [ ] Using images
- [ ] Using spritesheets

- [ ] Custom color system
- [ ] Color struct
- [ ] NewColor function
- [ ] Predefined Color constants

37 changes: 21 additions & 16 deletions website/roadmap/v2.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
# 🛣️ Roadmap for V2

## V2
- [ ] Custom color system
- [ ] Color struct
- [ ] NewColor function
- [ ] Predefined Color constants

- [ ] Custom window system
- [ ] Linux
- [ ] X11
- [ ] Wayland
- [ ] Windows
- [ ] Win32
- [ ] Mac
- [ ] Coco
- [ ] 2 Ring Window System
- [ ] Ring 1
- [ ] Linux C Wrapper
- [ ] X11
- [ ] Wayland
- [ ] Windows C Wrapper
- [ ] Win32
- [ ] Mac Objective-C++ Wrapper
- [ ] Cocoo
- [ ] Ring 2
- [ ] API around Ring 1 wrappers

- [ ] GUI
- [ ] Buttons
- [ ] Text

- [ ] Networking
- [ ] TCP
- [ ] UDP
- [ ] Websockets
- [ ] Webtransport

## V2.1
- [ ] Add-ons to 2 Ring Window system
- [ ] Ring 1
- [ ] Mac Objective-C++ Wrapper
- [ ] Cocoo


- [ ] Vuelto Editor
- [ ] Full blown editor
Expand All @@ -30,4 +35,4 @@
- [ ] Customization
- [ ] Exporting
- [ ] Importing
- [ ] Project management
- [ ] Project management

0 comments on commit 393290e

Please sign in to comment.