Skip to content

Commit

Permalink
remove makefile from repository
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-thompson committed Sep 6, 2024
1 parent 5cc6886 commit bad7d60
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 32 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ __pycache__
/dist/
/.tox/
_version.py
makefile
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,52 +24,43 @@

![Screenshot](https://raw.githubusercontent.com/jacob-thompson/pong-arcade/main/src/pong_arcade/data/gfx/screenshot.png)

This application is a pythonic implementation of [Pong](https://en.wikipedia.org/wiki/Pong), a game originally developed and released by [Atari](https://en.wikipedia.org/wiki/Atari,_Inc._(1972%E2%80%931992)) in 1972. `pong-arcade` was created using [pygame](https://www.pygame.org/wiki/about) and [various resources](https://github.com/jacob-thompson/pong-arcade/tree/main/src/pong_arcade/data).
This application is an implementation of [Pong](https://en.wikipedia.org/wiki/Pong), originally developed and released by [Atari](https://en.wikipedia.org/wiki/Atari,_Inc._(1972%E2%80%931992)) in 1972. `pong-arcade` was created using [pygame](https://www.pygame.org/wiki/about) and [various resources](https://github.com/jacob-thompson/pong-arcade/tree/main/src/pong_arcade/data).


## Play

#### Install

As per [PEP 668](https://peps.python.org/pep-0668/), it is recommended to use `pipx` to install this application, which may need to be [installed separately](https://github.com/pypa/pipx#install-pipx). `pipx` installs applications and their dependencies into their own virtual environment.
As per [PEP 668](https://peps.python.org/pep-0668/), it is recommended to use `pipx` to install this application:

```sh
pipx install pong-arcade
```

Running `pip` as usual may work on your system.
Otherwise:

```sh
pip install pong-arcade
```

###### From Source

This application may also be built and installed from source. You may need to install the pip package `build` in order to do this. Clone the repository, and then run the following commands in the project's directory.
This application may also be built and installed from source. Requires the pip package `build`:

```sh
python -m build # builds the package
pipx install dist/*.tar.gz # installs the application
python -m build
pipx install dist/*.tar.gz
```

You could use `make` to simplify these commands. This requires [GNU Make](https://www.gnu.org/software/make/#download) to be installed on your system.

```sh
make install # builds and installs the application
python -m build
pip install dist/*.tar.gz
```

#### Run

The application should now be on your PATH. Run `pong` to execute the application.

###### From Source

```sh
make # builds, installs, and executes the application
```

```sh
pong # executes the application
pong
```

## Controls
Expand Down
14 changes: 0 additions & 14 deletions makefile

This file was deleted.

0 comments on commit bad7d60

Please sign in to comment.