https://github.com/jerluc/3r4

welcome to a new era
https://github.com/jerluc/3r4

Last synced: 24 days ago
JSON representation

welcome to a new era

• Host: GitHub
• URL: https://github.com/jerluc/3r4
• Owner: jerluc
• License: apache-2.0
• Created: 2016-08-09T08:29:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-29T06:28:50.000Z (over 7 years ago)
• Last Synced: 2024-11-05T20:41:34.823Z (2 months ago)
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
3R4

===

Super secret game

# Development

### Developing the 3R4 shell

The project is like any other setuptools/distutils Python project. Just

run:

```bash

python setup.py install

```

or

```bash

pip install --editable .

```

to install the development build.

### Developing the Docker image

I've included a few helper scripts that should allow you to develop

against the Docker image with ease:

```bash

# Rebuilds the Docker image

./build.sh

# Runs the Docker image (basically just an SSH server with the 3R4 shell

# installed)

./run.sh

# SSHes into the running Docker container (by default, using the

# 'guest' user; this can be changed by using a different user name as

# the script argument)

./login.sh

# Shuts down the running container and cleans up the image fork

./stop.sh

```

# Usage

For now, you can only enter the shell if running locally:

```bash

3R4

```

To run the Docker container, use the instructions above