bjuspi / hephaestus

A repository for small automation/crazy/game projects by the OpenCode

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Contribution guidelines
   • Running the project
3. License
4. Starware
5. Contributors

About The Project

This repository will contain small automation/crazy/fun projects made using Python Programming Language. At present, the projects contained in this repository are:

1. Star Wars Lite
2. Grumpy

This repository is primarily maintained by @007vedant and @opencodenitr org.

Getting Started

To make the contributions to the projects find the steps below.

Prerequisites

• Python

• PyGame

• Git

Contribution guidelines 🎃

---

Our Slack Community: Slack Invite

Contributions for **Hacktoberfest 2021** are welcome 🎉🎉

Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your local system
3. Commit changes to your own separate branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Running the project

1. Although every project can be run in a global environment after installing the required dependencies, we strongly recommend using a virtual environment for each project to avoid clashes and compatibility issues and to ease the contribution. A virtual environment can be setup using this.

2. Inside the virtual environment, install the dependencies and libraries for each project using the requirements.txt file available in the project directories. To install the dependencies use the following in the terminal

   python -m pip install -r requirements.txt

3. The project can be run directly via any text editor using main.py file present in the project directories. To run the project via terminal, use the following command.

   python main.py

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Starware

opencodenitr/hephaestus is Starware. This means you're free to use the project, as long as you star its GitHub repository. Your appreciation makes us grow and glow up. ⭐

Contributors ✨

Thanks goes to these wonderful people 🥇

Made with contributors-img.

This project follows the all-contributors specification. Contributions of any kind welcome!