From 393290eeca4d2fa8b87e06b830a4300924c602d9 Mon Sep 17 00:00:00 2001 From: dimkauzh Date: Mon, 22 Jul 2024 23:49:56 +0200 Subject: [PATCH] Docs + Format action --- .github/workflows/ci_check.yml | 2 +- Makefile | 5 ++++ website/docs/index.md | 7 +++-- website/home.md | 2 +- website/roadmap/v1.md | 47 +++++++++++++++++++++++++++++----- website/roadmap/v2.md | 37 ++++++++++++++------------ 6 files changed, 73 insertions(+), 27 deletions(-) diff --git a/.github/workflows/ci_check.yml b/.github/workflows/ci_check.yml index fb63682..2a45380 100755 --- a/.github/workflows/ci_check.yml +++ b/.github/workflows/ci_check.yml @@ -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') diff --git a/Makefile b/Makefile index 4c423ce..61281f7 100755 --- a/Makefile +++ b/Makefile @@ -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/ + diff --git a/website/docs/index.md b/website/docs/index.md index f760d9c..3673d12 100755 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -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. diff --git a/website/home.md b/website/home.md index f099583..fe0c684 100755 --- a/website/home.md +++ b/website/home.md @@ -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.

Made for you by the Vuelto Team ❤️

diff --git a/website/roadmap/v1.md b/website/roadmap/v1.md index 1f6f725..0e37c54 100755 --- a/website/roadmap/v1.md +++ b/website/roadmap/v1.md @@ -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 @@ -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 diff --git a/website/roadmap/v2.md b/website/roadmap/v2.md index 9d5abc3..bb47a83 100755 --- a/website/roadmap/v2.md +++ b/website/roadmap/v2.md @@ -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 @@ -30,4 +35,4 @@ - [ ] Customization - [ ] Exporting - [ ] Importing - - [ ] Project management \ No newline at end of file + - [ ] Project management