Skip to content

Commit

Permalink
Finally wrote the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BurkhalterY committed Apr 7, 2024
1 parent 22b93dc commit f0156a0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 161 deletions.
95 changes: 0 additions & 95 deletions contributing.md

This file was deleted.

84 changes: 18 additions & 66 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,40 @@
# Project Title
# Normalux.ch

One Paragraph of project description goes here
The best way to see what this project is is to try it by yourself. It only takes 45 seconds.

## Getting Started
https://www.normalux.ch/

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
## Getting Started

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```
- PHP 7.4 (PHP ⩾8.0 is not compatible yet)
- MySQL

### Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system
- Clone the repository and copy config files:

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```bash
git clone https://github.com/BurkhalterY/normalux.ch.git
cd normalux.ch/application/config/
cp config.php.sample config.php
cp database.php.sample database.php
```

## Deployment
- Edit `database.php` with your MySQL credentials.
- Manually create the database and import `database/normalux.sql` into it.

Add additional notes about how to deploy this on a live system
You can use an all-in-one solution such as XAMPP, UwAmp to run this project. Alternatively, you can use the following command in the repository root: `php7.4 -S 0.0.0.0:8000`.

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
- [CodeIgniter 3](https://codeigniter.com/userguide3/) - the PHP framework

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
This project is not actively maintained, but feel free to contribute. I'll read all issues and PR.

## Acknowledgments

* Hat tip to anyone whose code was used
* Inspiration
* etc

- Pokédraw - A similar website belonging to the past. The original idea come from there.

0 comments on commit f0156a0

Please sign in to comment.