evinReynaud / Mafia

A Go implementation of the Mafia game

MAFIA

A secret role game about defending your city, or your family

Overview

To be written...

Installing

To be written...

Contributing

This program is written in Go. The code follows most of the language guidelines and idiomatic usages.

However, it does not follows the standard code organization with a global workspace. This repository is designed to contain its own workspace such as would be done in many other languages.

Go

If you are new to Go, I strongly advise you to check the following links before contributing to this project.

• Installing Go
• A tour of go to learn the basics and syntax of the language
• A first and simple program to learn how to compile a program and a library, as well as writing and running tests. Do not forget however that the file organization in this repository is not standard, so the command used must be given more verbose arguments.
• Effective Go: A document that gives tips for writing clear, idiomatic Go code. A must read for any new Go programmer.

All these resources and many more can be found on the official Go website.

Building for contributing

Before testing this code, you will need the assert package. To install it, run the following command:

go get -u github.com/stretchr/testify/assert

To build this code, run the make build command.

To run the tests, run the make test command. You will need the assert package (see above).