|
| 1 | +[](https://github.com/GitTerraGame/GitTerra/actions/workflows/gitterra.yml) |
| 2 | + |
1 | 3 | # GitTerra
|
2 | 4 |
|
3 | 5 | A game of coding where you can play by doing the usual coding activities
|
4 | 6 |
|
5 |
| -## Installation |
6 |
| - |
7 |
| -Clone this repository |
8 |
| - |
9 |
| -``` |
10 |
| -git clone https://github.com/GitTerraGame/GitTerra |
11 |
| -cd GitTerra |
12 |
| -``` |
13 |
| - |
14 |
| -### Dependencies |
15 |
| - |
16 |
| -#### Node modules |
17 |
| - |
18 |
| -This project uses Node.js and npm, install them from here: |
19 |
| -https://nodejs.org/ |
20 |
| - |
21 |
| -Then in the root of the repository, run npm to install the dependencies: |
22 |
| - |
23 |
| -``` |
24 |
| -npm install |
25 |
| -``` |
26 |
| - |
27 |
| -#### SCC code analysis tool |
28 |
| - |
29 |
| -We also use [scc](https://github.com/boyter/scc) to generate code statistics. It is written in Go so you can install it by running |
30 |
| - |
31 |
| -``` |
32 |
| -go get -u github.com/boyter/scc/ |
33 |
| -``` |
34 |
| - |
35 |
| -or if you're on a Mac, you can also install it using Homebrew: |
36 |
| - |
37 |
| -``` |
38 |
| -brew install scc |
39 |
| -``` |
| 7 | +## GitHub |
40 | 8 |
|
41 |
| -See the repo for [other installation options](https://github.com/boyter/scc#install). |
| 9 | +If you use it on GitHub, you can simply add this action to your GitHub workflow: |
42 | 10 |
|
43 |
| -## Running the map generator |
| 11 | +https://github.com/marketplace/actions/play-gitterra |
44 | 12 |
|
45 |
| -To generate the map, run the following command: |
| 13 | +## GitLab |
46 | 14 |
|
47 |
| -``` |
48 |
| -./generateRepoMap.sh --url <url-of-github-repo> |
49 |
| -``` |
| 15 | +If you use it on GitLab, see this component: |
50 | 16 |
|
51 |
| -Where `<url-of-github-repo>` is a URL of the GitHub project web page or `https://github.com/...` or `[email protected]:...` URL you use to clone the repository. |
| 17 | +https://gitlab.com/explore/catalog/gitterra/GitTerra |
52 | 18 |
|
53 |
| -So to generate a map for GitTerra itself you can run: |
| 19 | +## How to play |
54 | 20 |
|
55 |
| -``` |
56 |
| -./generateRepoMap.sh --url https://github.com/GitTerraGame/GitTerra |
57 |
| -``` |
| 21 | +[How hard is this game?](https://github.com/GitTerraGame/GitTerra/issues/new?template=feedback.md&labels=feedback) |
0 commit comments