Skip to content

Commit

Permalink
Convert README to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
xael-fry committed Mar 3, 2024
1 parent b80ed47 commit 470e4ee
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 66 deletions.
80 changes: 80 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Welcome to Play framework


[![GitHub Discussions](https://img.shields.io/github/discussions/playframework/play1?&logo=github&color=brightgreen)](https://github.com/playframework/play1/discussions)
[![Gitter](https://gitter.im/playframework/play1?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)](https://gitter.im/playframework/play1)
[![StackOverflow](https://img.shields.io/static/v1?label=stackoverflow&logo=stackoverflow&logoColor=fe7a16&color=brightgreen&message=playframework)](https://stackoverflow.com/tags/playframework)

[![Build Status](https://github.com/playframework/play1/actions/workflows/build-test.yml/badge.svg)](https://github.com/playframework/play1/actions/workflows/build-test.yml)
[![Repository size](https://img.shields.io/github/repo-size/playframework/play1.svg?logo=git)](https://github.com/playframework/play1)
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/playframework/play1&style=flat)](https://mergify.com)


Play framework makes it easier to build Web applications with Java. It is a clean alternative to bloated Enterprise Java stacks. It focuses on developer productivity and targets RESTful architectures. Play is a perfect companion to agile software development.

Learn more on the [https://www.playframework.com](https://www.playframework.com) website.

## Getting started

1. Install the latest version of Play framework and unzip it anywhere you want:
```
unzip play-*.zip -d /opt/play
```
2. Add the **play** script to your PATH:
```
export PATH=$PATH:/opt/play
```
3. Create a new Play application:
```
play new /opt/myFirstApp
```
4. Run the created application:
```
play run /opt/myFirstApp
```
5. Go to [localhost:9000/](http://localhost:9000) and you’ll see the welcome page.

6. Start developing your new application:

* [Your first application — the ‘Hello World’ tutorial](https://www.playframework.com/documentation/1.5.x/firstapp)
* [Tutorial — Play guide, a real world app step-by-step](https://www.playframework.com/documentation/1.5.x/guide1)
* [The essential documentation](https://www.playframework.com/documentation/1.5.x/home)
* [Java API](https://www.playframework.com/documentation/1.5.x/api/index.html)

## Get the source

Fork the project source code on [Github](http://github.com/playframework/play)

```
git clone git://github.com/playframework/play1.git
```

The project history is pretty big. You can pull only a shallow clone by specifying the number of commits you want with **--depth**:

```
git clone git://github.com/playframework/play1.git --depth 10
```

## Reporting bugs

Please report bugs on [our tracker](https://github.com/playframework/play1/issues).

## Learn More

* [www.playframework.com](https://www.playframework.com)
* [Download](https://www.playframework.com/download)
* [Install](https://www.playframework.com/documentation/1.5.x/install)
* [Create a new application](https://www.playframework.com/documentation/1.5.x/guide1)
* [Build from source](https://www.playframework.com/documentation/1.5.x/install#build)
* [Modules](https://www.playframework.com/modules)
* [Search or create issues](http://play.lighthouseapp.com/projects/57987-play-framework)
* [Get help](http://stackoverflow.com/questions/tagged/playframework)
* [Code of Conduct](https://www.playframework.com/conduct)
* [Contribute](https://github.com/playframework/play1/wiki/Contributor-guide)
* [Play contributor guidelines](https://www.playframework.com/contributing)

## Licence

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
66 changes: 0 additions & 66 deletions README.textile

This file was deleted.

0 comments on commit 470e4ee

Please sign in to comment.