aboutsummaryrefslogtreecommitdiff
path: root/bigtop-data-generators/bigtop-name-generator/README.md
blob: aa204b2b7595c0b7f8553bf7646ede6b664e6c0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License.  You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
BigTop Name Generator
=====================

Library for generating first and last names by sampling from the [Drupal
Name Database](https://www.drupal.org/project/namedb) which itself is based
on U.S. Census data.  Frequency of generates names are in proportion to
their frequencies according to the U.S. Census.

Building and Testing
--------------------
We use the Gradle build system for the BPS data generator so you'll need
to install Gradle on your system.
Once that's done, you can use gradle to run the included unit tests
and build the data generator jar.

To build:

    $ gradle build

This will create several directories and a jar located at:

    build/libs/bigtop-name-generator-1.1.0-SNAPSHOT.jar

Building automatically runs the included unit tests.  If you would prefer
to just run the unit tests, you can do so by:

    $ gradle test

To clean up the build files, run:

    $ gradle clean

To install a jar into your local maven repository:

    $ gradle install