timoreo/matrix-3ds-sdk
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improved documentation

Browse source
This commit is contained in:
Panagiotis Vasilopoulos 2020-07-08 21:00:18 +03:00
parent b5669e677b
commit cdd14851ea
No known key found for this signature in database
GPG key ID: FD806FDB3B2C5270
2 changed files with 30 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1 @@
liberapay: Sorunome

32
README.md
View file

@ -1,11 +1,28 @@
[![Support room on Matrix](https://img.shields.io/matrix/matrix-3ds-sdk:sorunome.de.svg?label=%23matrix-3ds-sdk:sorunome.de&logo=matrix&server_fqdn=sorunome.de)](https://matrix.to/#/#matrix-3ds-sdk:sorunome.de) [![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/Sorunome/donate)
# matrix-3ds-sdk # matrix-3ds-sdk
This is a matrix SDK for the Nintendo 3DS. This is a [Matrix](https://matrix.org/) client SDK for the Nintendo 3DS.
## Prerequisites
- [devkitPro](https://devkitpro.org/wiki/Getting_Started)
After installing devkitPro, you will need to download the following using [devkitPro pacman](https://devkitpro.org/wiki/devkitPro_pacman) or the devkitPro updater:
- 3ds-curl
- 3ds-jansson
- 3ds-dev
In other words, you'll need to run the following command in a Terminal/command prompt (with administrator/root privileges):
```
dkp-pacman -S 3ds-curl 3ds-jansson 3ds-dev
```
## Compilation ## Compilation
This project ships with a [Makefile](Makefile), which is meant to simplify the compilation process. If you're unfamiliar with them, you can find out more about GNU Make [here](https://www.gnu.org/software/make/).
```bash ```bash
make make
make install make install
@ -13,7 +30,16 @@ make install
## Usage ## Usage
This library depends on jansson and libcurl, so be sure to add the following libraries to your projects makefile: As mentioned above, this library depends on jansson and libcurl. Make sure to add them to your project's compilation options and make sure that they have been included in your project's Makefile:
``` ```
-lmatrix-3ds-sdk -ljansson `curl-config --libs` -lmatrix-3ds-sdk -ljansson `curl-config --libs`
``` ```
### Support
[![Support room on Matrix](https://img.shields.io/matrix/matrix-3ds-sdk:sorunome.de.svg?label=%23matrix-3ds-sdk:sorunome.de&logo=matrix&server_fqdn=sorunome.de)](https://matrix.to/#/#matrix-3ds-sdk:sorunome.de)
### Funding
[![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/Sorunome/donate)