Skip to content

Commit

Permalink
Replaced old instructions with links to GitHub / GitLab actions.
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeychernyshev committed Mar 20, 2024
1 parent 490f1b3 commit c7de33d
Showing 1 changed file with 10 additions and 46 deletions.
56 changes: 10 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,21 @@
[![we play GitTerra](https://github.com/GitTerraGame/GitTerra/actions/workflows/gitterra.yml/badge.svg)](https://github.com/GitTerraGame/GitTerra/actions/workflows/gitterra.yml)

# GitTerra

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

## Installation

Clone this repository

```
git clone https://github.com/GitTerraGame/GitTerra
cd GitTerra
```

### Dependencies

#### Node modules

This project uses Node.js and npm, install them from here:
https://nodejs.org/

Then in the root of the repository, run npm to install the dependencies:

```
npm install
```

#### SCC code analysis tool

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

```
go get -u github.com/boyter/scc/
```

or if you're on a Mac, you can also install it using Homebrew:

```
brew install scc
```
## GitHub

See the repo for [other installation options](https://github.com/boyter/scc#install).
If you use it on GitHub, you can simply add this action to your GitHub workflow:

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

To generate the map, run the following command:
## GitLab

```
./generateRepoMap.sh --url <url-of-github-repo>
```
If you use it on GitLab, see this component:

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.
https://gitlab.com/explore/catalog/gitterra/GitTerra

So to generate a map for GitTerra itself you can run:
## How to play

```
./generateRepoMap.sh --url https://github.com/GitTerraGame/GitTerra
```
[How hard is this game?](https://github.com/GitTerraGame/GitTerra/issues/new?template=feedback.md&labels=feedback)

0 comments on commit c7de33d

Please sign in to comment.