Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 1.99 KB

README.md

File metadata and controls

67 lines (51 loc) · 1.99 KB
Raw

cookiecutter-rust

Build Status

Powered by Cookiecutter, Cookiecutter Rust is a framework for jumpstarting production-ready rust projects quickly.

Features

  • Generous Makefile with management commands

Optional Integrations

  • If docker is used adds docker management commands to makefile
  • Option of TravisCI or None

Usage

Let's pretend you want to create a project called "echoserver". Rather than starting from scratch maybe copying some files and then editing the results to include your name, email, and various configuration issues that always get forgotten until the worst possible moment, get cookiecutter to do all the work.

First, get Cookiecutter. Trust me, it's awesome:

$ pip install cookiecutter

alternatively you can install cookiecutter with homebrew:

$ brew install cookiecutter

finally to run it based on this template just:

$ cookiecutter https://github.com/moogar0880/cookiecutter-rust.git

You will be asked about your basic info (name, project name, app name, etc.). This info will be used to customize your new project.

Warning: After this point, change 'Jon Nappi', 'moogar0880', etc to your own information.

Answer the prompts with your own desired options. For example:

project_name [myrustproject]: echoserver
full_name [Jon Nappi]: Jon Nappi
email [[email protected]]: [email protected]
git_root [github.com]: github.com
github_username [moogar0880]: moogar0880
project_short_description [A Rust project.]: Rusty Echo Server
use_git [y]: y
Select use_ci:
1 - travis
2 - none
Choose from 1, 2 [1]: 1

Enter the project and take a look around:

$ cd echoserver/
$ ls

Run make help to see the available management commands, or just run make build to build your project.

$ make help
$ make build
$ ./bin/echoserver