nxstart 0.3.0

Nintendo Switch homebrew project generator

nx-start
########

Project generator for Nintendo Switch homebrews. A work in progress.

Installation
============

Install from PyPi using `pip <http://www.pip-installer.org/en/latest>`_, a package manager for
Python.

.. code-block:: bash

$ pip install nxstart


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

.. code-block:: bash

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

Or, you can `download the source code <https://github.com/roedesh/nxstart>`_ for ``nxstart`` and then run:

.. code-block:: bash

$ python setup.py install

You may need to run the above commands with ``sudo``.

Creating a C++ (libnx) project
===============
Run ``nxstart cpp``. 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 created:

.. code-block:: bash

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

Creating a JS (BrewJS) project
===============
Run ``nxstart js``. It will ask for a project name, author name. The following project structure will be created:

.. code-block:: bash

project
│ .editorconfig
│ HOW-TO-RUN.txt // Explains how to run a BrewJS app on the Switch.
│ index.js // Your main application file
│
└───assets
│

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

.. code-block:: bash

$ nxstart -n "My new project" -a "John Doe" cpp --clion

Or if you don't use CLion:

.. code-block:: bash

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


Support for
`PyNX <https://github.com/nx-python/PyNX>`_ projects will be added soon.