mirror/sys-con
1
0
Fork 0
mirror of https://github.com/cathery/sys-con.git synced 2024-07-01 01:38:44 +00:00
Code Issues Projects Releases Wiki Activity

Update building instructions in README.md

Browse Source
This commit is contained in:
cathery 2020-03-10 22:06:17 +03:00 committed by GitHub
parent 5afe0ac4dd
commit 94f49095fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -45,9 +45,21 @@ sys-con comes with a config folder located at `sdmc:/config/sys-con/`. It contai
## Building (For developers)
The sysmodule uses the latest release of [libnx](https://github.com/switchbrew/libnx), grabbed from pacman.
Like all other switch projects, you need to have [devkitPro](https://switchbrew.org/wiki/Setting_up_Development_Environment) set up on your system.
To build it, go to the project directory and enter the command `make` to build a release of sys-con (will be stored in `out/`), or `make clean` to clean the project of any build files.
You will need to compile and use the master branch of [libnx](https://github.com/switchbrew/libnx) due to a [dependency](https://github.com/switchbrew/libnx/commit/c3b0b63471ee5309ea5040ad98f21919022ac9c7) in libstratosphere.
If you have **Visual Studio Code**, you can open the project as a folder and run the build tasks from inside the program. It also has Intellisense configured for switch development, if you have DEVKITPRO correctly defined in your environment variables. Handy!
Otherwise, you can open the console inside the project directory and use one of the following commands:
`make -j8`: Builds the project and its dependencies (libstratosphere) and places the resulting files in the output folder (out/). The -j8 means it will create 8 separate threads to speed up the building process. Make it lower if it freezes up your system.
`make clean`: Cleans the project files (but not the dependencies).
`make mrproper`: Cleans the project files and the dependencies.
For an in-depth explanation of how sys-con works, see [here](source).
## Support
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/H2H316ZQV)