diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 70 |
1 files changed, 66 insertions, 4 deletions
@@ -1,6 +1,10 @@ # No Gamepads -[](https://github.com/CatilGrass/NoGamepads/blob/main/LICENSE-MIT) - +| ITEM | SHIELD | +| ----------- | ------------------------------------------------------------ | +| License MIT | [](https://github.com/CatilGrass/NoGamepads/blob/main/LICENSE-MIT) | +| Status |  | + + `No Gamepads` expands your game's control capabilities: enabling players to connect mobile devices as in-game controllers. For local multiplayer games, it eliminates the need for each player to own a physical controller, avoids crowding around a single keyboard, and removes the hassle of configuring complex input mappings – just use a smartphone! @@ -10,11 +14,69 @@ -# The Plans +## Get Started + + If you want to develop a project or compile and run a library using this project, please follow the steps below: + +### Compile and Export Executables and Runtime Library + +Clone the repository locally. + +```bash +git clone git@github.com:CatilGrass/NoGamepads.git +cd NoGamepads +``` + +Then run `Cargo`. + +```bash +# Build in development environment +cargo dev_build +# Or build in release environment +cargo release_build + +# Export the project to ./export/'current_version_number'/ +cargo release + +# Export the project to ./export/dev/ +cargo dev +``` + +### Run the Console Program + + You can run the `console` program in the following ways: + +Use `Cargo` to run. + +```bash +cargo padc --help +``` + +Run directly after compiling the executable. + +```bash +# Linux & Unix +cargo dev_build +cargo dev +./export/dev/bin/padc --help # TODO :: Not adapted yet +``` +```powershell +:: Windows +cargo dev_build +cargo dev +.\export\dev\bin\padc.exe --help +``` + + + +## The Plans 1. ... -# Related Documentation +## Related Documentation + + If you want to learn more about this, please refer to the following documentation: 1. [How to compile project with Cargo](export/docs/How_to_export.md) 2. [About bindings](./core/bindings/About_bindings.md) + |