eden-emu/eden
24
3
Fork 15
Code Issues 138 Pull requests 56 Projects 1 Releases Packages Wiki Activity Actions

[docs] refactor: full rewrite, generalization + dedup #488

Merged
crueter merged 7 commits from refactor/docs-but-awesome into master 2025-09-18 02:37:03 +02:00
Conversation 9 Commits 7 Files changed 18 +573 -650
crueter commented 2025-09-15 06:21:17 +02:00
Owner
Copy link

"docs but awesome"

Combines most of the stuff that was repeated thrice over verbatim into a
single common Build Instructions page, with additional caveats marked
elsewhere. Prettifies some stuff too because why not.

cc: @Lizzie @DraVee @MaranBr @SDK-Chan

"docs but awesome" Combines most of the stuff that was repeated thrice over verbatim into a single common Build Instructions page, with additional caveats marked elsewhere. Prettifies some stuff too because why not. cc: @Lizzie @DraVee @MaranBr @SDK-Chan
crueter added 5 commits 2025-09-15 06:21:18 +02:00 
Signed-off-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
[docs] Refactor building with Linux
All checks were successful
eden-license / license-header (pull_request) Successful in 34s
Details
d0ea6316eb 
* this a initial PR to improve documentation of building under linux
  based on updated windows doc

Signed-off-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
Combines most of the stuff that was repeated thrice over verbatim into a
single common Build Instructions page, with additional caveats marked
elsewhere. Prettifies some stuff too because why not.

Signed-off-by: crueter <crueter@eden-emu.dev>
Signed-off-by: crueter <crueter@eden-emu.dev>
fix
All checks were successful
eden-license / license-header (pull_request) Successful in 43s
Details
71caf97337 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter changed title from [docs] refactor: full rewrite, generalization + dedup to WIP: [docs] refactor: full rewrite, generalization + dedup 2025-09-15 07:55:53 +02:00
DraVee commented 2025-09-16 03:30:26 +02:00
Member
Copy link

I think you should link the build steps on Readme.md to docs/Readme.md

https://git.eden-emu.dev/eden-emu/eden/src/branch/refactor/docs-but-awesome#building

I think you should link the build steps on `Readme.md` to `docs/Readme.md` https://git.eden-emu.dev/eden-emu/eden/src/branch/refactor/docs-but-awesome#building
DraVee reviewed 2025-09-16 03:33:44 +02:00
docs/scripts/Windows.md Outdated
@ -0,0 +27,4 @@
* The resulting zip will be placed into `artifacts` in the source directory.
## 🖥️ Method III: CLion Environment Setup
DraVee commented 2025-09-16 03:33:44 +02:00
Member
Copy link

Move to Build.md

Move to Build.md
crueter commented 2025-09-16 03:51:15 +02:00
Author
Owner
Copy link

That's the plan but I had limited time when making this, I will move it laterr

That's the plan but I had limited time when making this, I will move it laterr
crueter marked this conversation as resolved
Lizzie commented 2025-09-16 03:42:31 +02:00
Member
Copy link

Remove the use of emojis to make this readable on dumb terminals

Remove the use of emojis to make this readable on dumb terminals
crueter added 1 commit 2025-09-16 04:29:42 +02:00
[docs] clion, openbsd deps, readme
All checks were successful
eden-license / license-header (pull_request) Successful in 34s
Details
f62469004a 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter added 1 commit 2025-09-16 18:55:36 +02:00
add libusb to openbsd deps
All checks were successful
eden-license / license-header (pull_request) Successful in 38s
Details
2aa35a9319 
Signed-off-by: crueter <crueter@eden-emu.dev>
crueter commented 2025-09-17 02:17:02 +02:00
Author
Owner
Copy link

@Lizzie wrote in #488 (comment):

Remove the use of emojis to make this readable on dumb terminals

they should all be gone now

@Lizzie wrote in https://git.eden-emu.dev/eden-emu/eden/pulls/488#issuecomment-3744: > Remove the use of emojis to make this readable on dumb terminals they should all be gone now
crueter commented 2025-09-17 02:17:19 +02:00
Author
Owner
Copy link

cc @SDK-Chan @Lizzie for freebsd command

@DraVee and @MaranBr for windows/ubuntu

cc @SDK-Chan @Lizzie for freebsd command @DraVee and @MaranBr for windows/ubuntu
crueter force-pushed refactor/docs-but-awesome from 2aa35a9319 to 8f06e954cd 2025-09-17 02:30:41 +02:00 Compare
Lizzie approved these changes 2025-09-17 03:00:54 +02:00
requested reviews from MaranBr, SDK-Chan, DraVee 2025-09-17 03:04:07 +02:00
MaranBr approved these changes 2025-09-17 23:04:37 +02:00
DraVee commented 2025-09-18 02:27:50 +02:00
Member
Copy link

Non-devs will most likely not get the how-to and be easily spotted when asking questions

Looks good to me

Non-devs will most likely not get the how-to and be easily spotted when asking questions Looks good to me
DraVee approved these changes 2025-09-18 02:28:44 +02:00
crueter force-pushed refactor/docs-but-awesome from 8f06e954cd to 94932270a5 2025-09-18 02:36:33 +02:00 Compare
crueter changed title from WIP: [docs] refactor: full rewrite, generalization + dedup to [docs] refactor: full rewrite, generalization + dedup 2025-09-18 02:36:37 +02:00
crueter merged commit e1ffeec212 into master 2025-09-18 02:37:03 +02:00
crueter deleted branch refactor/docs-but-awesome 2025-09-18 02:37:04 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Lizzie
SDK-Chan
MaranBr
DraVee
Labels
Clear labels   
android

Specific to android platform

  
audio

   
bug

Something is not working

  
ci

For changes to the ci/building

  
confirmed

Used when testers confirm a bug is reported and it is reproducable.

  
core

For core changes to the emulator

  
desktop

Specific to desktop PCs, handhelds, etc.

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
frontend

Frontend changes

  
fw

Changes related to firmware

  
git

For enhancements or changes regarding git.

  
graphics

   
loader

For changes to any of the loader implementations

  
nv gpu

For use with changes that involve the emulator GPU and any services.

  
ui
No labels
android
audio
bug
ci
confirmed
core
desktop
duplicate
enhancement
frontend
fw
git
graphics
loader
nv gpu
ui
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: eden-emu/eden#488
No description provided.
Delete branch "refactor/docs-but-awesome"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?