Skip to content

Commit

Permalink
Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
XorTroll committed Mar 23, 2019
1 parent e5336a6 commit 6c097ae
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ It uses libnx and SDL2, so both libraries are required.

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

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

## Internal structure and performance

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

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.

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

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.

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`)
### Simple project layout

This is how a regular Plutonium project would (more or less) have its Makefile and project layout using Plutonium:

- Makefile

Include the main header:
```Makefile
...

```cpp
#include <pu/Plutonium>
LIBS := -lpu -lfreetype -lSDL2_ttf -lSDL2_gfx -lSDL2_image -lSDL2 -lEGL -lGLESv2 -lglapi -ldrm_nouveau -lpng -ljpeg `sdl2-config --libs` `freetype-config --libs` -lnx
LIBDIRS := $(PORTLIBS) $(LIBNX) $(CURDIR)/Plutonium

...
```

And don't forget to add the libraries mentioned in the first section!
- Project directory

```txt
Project
|
|-- Makefile
|-- source
|-- include
|-- Plutonium
|
|-- include
|-- lib
```

## Building

Clone the repository, go into `Plutonium` directory and run `make`.
Clone the repository, cd into `Plutonium` directory and run `make`.

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

Expand Down

0 comments on commit 6c097ae

Please sign in to comment.