Git Product home page Git Product logo

nxstart's Introduction

nx-start

Project generator for Nintendo Switch homebrews.

PyPI version Build status Requirements Status

Table of Contents

Features

  • Generate a libnx (C++) project using nxstart libnx
  • Generate a libtransistor (C) project using nxstart libt
  • Generate a BrewJS (Javascript) project using nxstart brewjs
  • Generate a PyNX (Python) project using nxstart pynx

Installation

Install from PyPi using pip, a package manager for Python.

pip install nxstart

Don't have pip installed? Try installing it, by running this from the command line:

curl "https://bootstrap.pypa.io/get-pip.py" | python

Or, you can download the source code for nxstart and then run:

python setup.py install

You may need to run the above commands with sudo.

Generating a libnx (C++) project

Run nxstart libnx. It will ask for a project name, author name and if you are using CLion (IDE by Jetbrains). If you say yes to CLion, CMakeLists.txt will be included.

The following project structure will be generated:

project
│   .editorconfig 
│   .gitignore
│   CMakeLists.txt  // Only if you use CLion
│   Makefile      
│   icon.jpg  
│   README.md
│
└───data
│   
└───include
│ 
└───source
    │   main.cpp    // Your main application file

Generating a libtransistor (C) project

Run nxstart libt. It will ask for a project name, author name and if you are using CLion (IDE by Jetbrains). If you say yes to CLion, CMakeLists.txt will be included.

The following project structure will be generated:

project
│   .editorconfig 
│   .gitignore
│   CMakeLists.txt  // Only if you use CLion
│   main.c          // Your main application file
│   Makefile
│   icon.jpg
│   README.md           
│

Generating a BrewJS (Javascript) project

Run nxstart brewjs. It will ask for a project name and author name. The following project structure will be generated:

project
│   .editorconfig 
│   .gitignore     
│   package.json
│   Source.js        // Your main application file
│   README.md   
│
└───assets
│   

Generating a PyNX (Python) project

Run nxstart pynx. It will ask for a project name and author name. The following project structure will be generated:

project
│   .editorconfig 
│   .gitignore     
│   main.py        // Your main application file
│   README.md   
│   

Skip prompts

To skip the prompts, provide the necessary flags. For example:

nxstart -n "My new project" -a "John Doe" libnx --clion

Or if you don't use CLion:

nxstart -n "My new project" -a "John Doe" libnx --no-clion

Running tests

Tests can be run with the pytest command. If you are contributing code, make sure all tests are green before submitting a PR.

nxstart's People

Contributors

jakibaki avatar roedesh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

jakibaki

nxstart's Issues

[libnx] No rule to make target `README.txt.o'

Hello.

I'm on mac os, using latest release of devkitpro (installed with pacman) and I can't compile libnx (fresh) project generated with nxstart, it fails with the following error:

$ nxstart libnx
v1.1.2 - by roedesh <Ruud Schroën>
Please enter the name of your project: nx-project
Please enter your name: tuxfamily
Are you using CLion? [y/N]: y
Successfully created the libnx project!
$ cd nx-project/ 
$ make                                                                                                                                                                                                                                                                            Dim 25 nov 21:10:28 2018
make[1]: *** No rule to make target `README.txt.o', needed by `/Users/tuxfamily/Projects/nx-project/out/nx-project.elf'.  Stop.
make: *** [build] Error 2

Deleting the file data/README.txt fix the issue... but there is probably a better solution :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.