Skip to content

Commit e06571a

Browse files
Convert README from RST to MD (#2401)
Co-authored-by: johan.tuls <johan.tuls@bam.com>
1 parent 1462b8c commit e06571a

4 files changed

Lines changed: 77 additions & 106 deletions

File tree

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
[<img src="https://beeware.org/project/briefcase/briefcase.png" width="72" alt="logo" />](https://beeware.org/briefcase)
2+
3+
# Briefcase
4+
5+
[![Python Versions](https://img.shields.io/pypi/pyversions/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
6+
[![PyPI Version](https://img.shields.io/pypi/v/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
7+
[![Maturity](https://img.shields.io/pypi/status/briefcase.svg)](https://pypi.python.org/pypi/briefcase)
8+
[![BSD License](https://img.shields.io/pypi/l/briefcase.svg)](https://github.com/beeware/briefcase/blob/main/LICENSE)
9+
[![Build Status](https://github.com/beeware/briefcase/workflows/CI/badge.svg?branch=main)](https://github.com/beeware/briefcase/actions)
10+
[![Discord server](https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic)](https://beeware.org/bee/chat/)
11+
12+
Briefcase is a tool for converting a Python project into a standalone
13+
native application. You can package projects for:
14+
15+
- Mac
16+
- Windows
17+
- Linux
18+
- iPhone/iPad
19+
- Android
20+
- Web
21+
22+
Support for AppleTV, watchOS, and wearOS deployments is planned.
23+
24+
## Getting started
25+
26+
To install Briefcase, run:
27+
28+
$ python -m pip install briefcase
29+
30+
If you would like a full introduction to using Briefcase, try the
31+
[BeeWare tutorial](https://docs.beeware.org). This tutorial walks you
32+
through the process of creating and packaging a new application with
33+
Briefcase.
34+
35+
## Financial support
36+
37+
The BeeWare project would not be possible without the generous support
38+
of our financial members:
39+
40+
[![Anaconda logo](https://beeware.org/community/members/anaconda/anaconda-large.png)](https://anaconda.com/)
41+
42+
Anaconda Inc. - Advancing AI through open source.
43+
44+
Plus individual contributions from [users like
45+
you](https://beeware.org/community/members/). If you find Briefcase, or
46+
other BeeWare tools useful, please consider becoming a financial member.
47+
48+
## Documentation
49+
50+
Documentation for Briefcase can be found on [Read The
51+
Docs](https://briefcase.readthedocs.io).
52+
53+
## Community
54+
55+
Briefcase is part of the [BeeWare suite](https://beeware.org). You can
56+
talk to the community through:
57+
58+
- [@beeware@fosstodon.org on Mastodon](https://fosstodon.org/@beeware)
59+
- [Discord](https://beeware.org/bee/chat/)
60+
- The Briefcase [GitHub Discussions
61+
forum](https://github.com/beeware/briefcase/discussions)
62+
63+
We foster a welcoming and respectful community as described in our
64+
[BeeWare Community Code of
65+
Conduct](https://beeware.org/community/behavior/).
66+
67+
## Contributing
68+
69+
If you experience problems with Briefcase, [log them on
70+
GitHub](https://github.com/beeware/briefcase/issues).
71+
72+
If you'd like to contribute to Briefcase development, our [contribution
73+
guide](https://briefcase.readthedocs.io/en/latest/how-to/contribute/index.html)
74+
details how to set up a development environment, and other requirements
75+
we have as part of our contribution process.

README.rst

Lines changed: 0 additions & 105 deletions
This file was deleted.

changes/2378.misc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Rewritten the ``README.rst`` to markdown (``README.md``) using pandoc.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
1010
dynamic = ["version"]
1111
name = "briefcase"
1212
description = "Tools to support converting a Python project into a standalone native application."
13-
readme = "README.rst"
13+
readme = "README.md"
1414
requires-python = ">= 3.9"
1515
license = "BSD-3-Clause"
1616
license-files = [

0 commit comments

Comments
 (0)