Skip to content

Commit 6c097ae

Browse files
author
XorTroll
committed
Improved README
1 parent e5336a6 commit 6c097ae

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

README.md

+28-9
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ It uses libnx and SDL2, so both libraries are required.
88

99
To be more exact, this libraries should be installed via pacman:
1010

11-
```
12-
-lnx -lfreetype -lSDL2_ttf -lSDL2_gfx -lSDL2_image -lSDL2 -lEGL -lGLESv2 -lglapi -ldrm_nouveau -lpng -ljpeg `sdl2-config --libs` `freetype-config --libs`
11+
```sh
12+
pacman -S switch-sdl2 switch-sdl2_ttf switch-sdl2_gfx
1313
```
1414

1515
## Internal structure and performance
1616

17-
Plutonium uses software-accelerated SDL2 rendering.
17+
Plutonium uses SDL2 (SDL2 via OpenGL) rendering.
1818

1919
Plutonium's performance is based on WPF's system. The user doesn't directly interact with the rendering, as it's done via a main rendering system and different objects to render.
2020

@@ -30,19 +30,38 @@ Check the [documentation](https://XorTroll.github.io/Plutonium/) for a more deta
3030

3131
On the [releases](https://github.com/XorTroll/Plutonium/releases) page you have all the released versions. All of them are zipped files, containing `include` and `lib` directories.
3232

33-
To link them to a devkitPro libnx project, on the `LIBDIRS` variable of the Makefile add the folder containing the two folders mentioned above. (if you set `plutonium`, place the other two folders as `plutonium/include` and `plutonium/lib`)
33+
### Simple project layout
34+
35+
This is how a regular Plutonium project would (more or less) have its Makefile and project layout using Plutonium:
36+
37+
- Makefile
3438

35-
Include the main header:
39+
```Makefile
40+
...
3641

37-
```cpp
38-
#include <pu/Plutonium>
42+
LIBS := -lpu -lfreetype -lSDL2_ttf -lSDL2_gfx -lSDL2_image -lSDL2 -lEGL -lGLESv2 -lglapi -ldrm_nouveau -lpng -ljpeg `sdl2-config --libs` `freetype-config --libs` -lnx
43+
LIBDIRS := $(PORTLIBS) $(LIBNX) $(CURDIR)/Plutonium
44+
45+
...
3946
```
4047

41-
And don't forget to add the libraries mentioned in the first section!
48+
- Project directory
49+
50+
```txt
51+
Project
52+
|
53+
|-- Makefile
54+
|-- source
55+
|-- include
56+
|-- Plutonium
57+
|
58+
|-- include
59+
|-- lib
60+
```
4261

4362
## Building
4463

45-
Clone the repository, go into `Plutonium` directory and run `make`.
64+
Clone the repository, cd into `Plutonium` directory and run `make`.
4665

4766
You will need devkitPro, libnx and all the libraries mentioned above installed via pacman.
4867

0 commit comments

Comments
 (0)