Getting Started

So you want to try out nu? Great! Let's get started.

Prerequisites

First, you will need to be running on Linux or Mac OS X. Sorry, Windows users!

Afterwards, make sure you have a C compiler and git installed.

Linux

If you already have git and a C compiler installed, you can skip this step.

If you don't, run this command to install build-essential (essential tools for building applications on Linux) and git (assuming you're on Debian or Ubuntu or some other operating system that uses apt-get):

sudo apt-get install build-essential git

If you're on a system that uses yum or pacman or something else, I'm going to assume you know how to download those packages :wink:

Mac OS X

Downloading XCode from the app store will get you a C compiler and git.

Dependencies

It's now time to download nu. Open a terminal window and clone nu:

git clone https://github.com/nu-dev/nu

Change directory to the recently cloned repository:

cd nu

Building

Building nu will automatically fetch and build all the required dependencies.

Still in terminal in the cloned repository folder, run:

make

Done! nu is now ready for consumption :smile:

Creating a blog

Now that nu is built, you may want to create your own blog. Copy the file nu into another folder where you want your blog.

Once in that folder, run ./nu new . to create a new blog environment. A configuration file will be created, along with some folders:

• theme/ - a place to put themes for nu. You can create your own, or download the nu theme pack following the instructions here
• posts/ - output folder for posts (posts follow the naming convention yyyy-mm-dd-Title.md)
• special/ - output folder for "special" posts (posts whose filenames do not follow the convention above)
• resources/ - folder for resources such as images
• raw/ - folder to put everything you write

The main folder that matters is the raw folder, as this is where you put the files you want to see on your blog.