Skip to content

Commit c7de33d

Browse files
Replaced old instructions with links to GitHub / GitLab actions.
1 parent 490f1b3 commit c7de33d

File tree

1 file changed

+10
-46
lines changed

1 file changed

+10
-46
lines changed

README.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,21 @@
1+
[![we play GitTerra](https://github.com/GitTerraGame/GitTerra/actions/workflows/gitterra.yml/badge.svg)](https://github.com/GitTerraGame/GitTerra/actions/workflows/gitterra.yml)
2+
13
# GitTerra
24

35
A game of coding where you can play by doing the usual coding activities
46

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
408

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:
4210

43-
## Running the map generator
11+
https://github.com/marketplace/actions/play-gitterra
4412

45-
To generate the map, run the following command:
13+
## GitLab
4614

47-
```
48-
./generateRepoMap.sh --url <url-of-github-repo>
49-
```
15+
If you use it on GitLab, see this component:
5016

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
5218

53-
So to generate a map for GitTerra itself you can run:
19+
## How to play
5420

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

Comments
 (0)