Skip to content

Commit d5e45dd

Browse files
committed
Add LICENSE and README files with project details and usage instructions
1 parent 14d06f6 commit d5e45dd

2 files changed

Lines changed: 71 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (C) 2022-2026 EuroPython Society
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# EuroPython Companion
2+
3+
The official, open-source companion app for [EuroPython](https://europython.eu), maintained by the EuroPython Society. Browse the schedule, favourite sessions, get reminders before your talks start, and find your way around the venue. Works fully offline once you've opened it at least once.
4+
5+
Built with React Native (Expo), available for iOS, Android, and the web.
6+
7+
## Features
8+
9+
- **Schedule browsing:** the full conference programme, filterable by day and track, with room and time info kept in sync with the official schedule.
10+
- **Favourites:** star the sessions you don't want to miss and pull up a personal agenda at any time.
11+
- **Notifications:** optional reminders shortly before a favourited session starts.
12+
- **Speakers:** look up who's talking, what they're presenting, and when.
13+
- **Venue maps:** floor plans for the conference venue, including accessibility info.
14+
- **Offline-first:** the programme is cached on your device, so the app keeps working without a connection (handy inside a busy conference venue).
15+
- **Code of Conduct:** quick access to the EuroPython Code of Conduct and contacts, right from the app.
16+
- **Light, dark, and night mode** themes.
17+
- **Multi-year support:** the app can switch between conference years as data becomes available.
18+
19+
## Getting the app
20+
21+
We're still waiting on approval from the Apple App Store and Google Play, so we're not listed there just yet. In the meantime:
22+
23+
- **Android:** grab the latest APK from the [Releases](https://github.com/EuroPython/europython-companion/releases) page and install it directly on your device.
24+
- **iOS:** until we're approved, the only way to run the app is to build it yourself from source (see below). Sorry for the extra hoops, we'll update this section the moment we're live on the App Store.
25+
- **Web (PWA):** always available, no store needed, just open the site and install it to your home screen. It's a solid, bare-bones way to use the app today. A few native features, like notifications and calendar integration, aren't available in the PWA yet.
26+
27+
## Running it yourself
28+
29+
You'll need [Node.js](https://nodejs.org) and [pnpm](https://pnpm.io).
30+
31+
```sh
32+
pnpm install
33+
pnpm start
34+
```
35+
36+
Full setup instructions, troubleshooting, and all available scripts are in [`docs/getting-started.md`](docs/getting-started.md).
37+
38+
## Contributing
39+
40+
Bug reports, feature suggestions, and pull requests are welcome. A few things worth knowing before diving in:
41+
42+
- The [`docs/`](docs/README.md) directory is the maintained technical reference for this codebase: architecture, data flow, navigation, how to add a screen, and so on. Start there.
43+
- The app has no backend of its own, it reads static, publicly published conference data. See [`docs/configuration.md`](docs/configuration.md) for details.
44+
- There's no dedicated test suite yet; changes are validated with type-checking and manual testing of the affected flow. See [`docs/testing.md`](docs/testing.md).
45+
46+
If you're planning a larger change, opening an issue first to discuss it is appreciated.
47+
48+
## License
49+
50+
See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)