xiangqi: Chinese Chess Utilities

#' xiangqi: utilities to analyze and archive xiangqi games
#'
#' The xiangqi package is a set of tool that makes the life of a xiangqi player
#' easier. Xiangqi is a chess-variant popular in Asia, and is by player-base arguably
#' the most popular board game in the world. However, language barriers, availability
#' of materials and closed-circuit software and databases obfuscate the learning and
#' playing process.
#'
#' A core consideration of the package is that each user has a preference for
#' a managing their own balance between ease-of-use and adaptability. For this reason
#' the functions are chopped up in bite-size parts, each following a logical process
#' in the analysis process.
#'
#' 1. Read data
#' 2. Analyze
#' 3. Describe
#' 4. Visualize
#' 5. Export
#'
#' For a detailed explanation of what xiangqi is, and how to play it, see
#' \code{vignette("xiangi-rules")}
#'
#' @section Setting up xiangqi
#' To get the most out of xiangqi,


#' @docType package
#' @name xiangqi
NULL