diff --git a/README.md b/README.md deleted file mode 100644 index 8267133..0000000 --- a/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# Kaiteki - -[![Build status](https://img.shields.io/github/workflow/status/Kaiteki-Fedi/Kaiteki/Build%20&%20Deploy)](https://github.com/Kaiteki-Fedi/Kaiteki/actions/workflows/ci.yml) [![CodeFactor](https://www.codefactor.io/repository/github/kaiteki-fedi/kaiteki/badge)](https://www.codefactor.io/repository/github/kaiteki-fedi/kaiteki) -[![Translation status](https://wl.craftplacer.moe/widgets/kaiteki/-/app/svg-badge.svg)](https://wl.craftplacer.moe/engage/kaiteki/) - - - -A [快適 (kaiteki)](http://takoboto.jp/?w=1200120) Fediverse client for microblogging instances, made with [Flutter](https://flutter.dev/) and [Dart](https://dart.dev/). - -Currently, Kaiteki is still in a **proof-of-concept/alpha stage**, with simple Mastodon/Pleroma and Misskey support, future backends could follow. See ["What's working, what's missing?"](#whats-working-whats-missing). - -## Screenshots - - - - -
Screenshot of a Misskey feed inside Kaiteki on a phoneScreenshot of an user inside Kaiteki on a tablet
- -## Platforms & Releases - -If you want to try out Kaiteki, there are automatic builds available for use. - - - - - - - - - - - - - - - - - - - - - - - - -
Web
(recommended)
WindowsLinuxAndroidmacOSiOS
BinariesVisit web versionDownload latest binariesDownload latest binariesDownload latest APKNot supported.
Packages / InstallersNo reliable packaging yet.
Help us!
- AppImage -

- Help us package for more platforms! -
- - -## What's working, what's missing? - -Currently, Kaiteki only allows viewing timelines, making text posts and viewing users. - -Most important API calls for Misskey, Mastodon/Pleroma are already implemented but need a UI implementation. - -Other features that are missing are extensive settings, unit tests, and many other things. **If you'd like to contribute, feel free to do so.** - -## Compiling Kaiteki - -Depending on your platform you might have to take extra steps. -See [this page for steps on compiling for desktop](https://docs.flutter.dev/desktop), and [this page for steps on compiling for web](https://flutter.dev/docs/get-started/web). - -```sh -flutter upgrade # upgrade flutter to its latest version -flutter pub get # get packages - -# run -flutter run - -# ... or compile a release build -flutter build apk --release -flutter build windows --release -flutter build linux --release -flutter build web --release -``` diff --git a/README.md b/README.md new file mode 120000 index 0000000..badf1ce --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +src/kaiteki/README.md \ No newline at end of file diff --git a/src/kaiteki/README.md b/src/kaiteki/README.md new file mode 100644 index 0000000..8267133 --- /dev/null +++ b/src/kaiteki/README.md @@ -0,0 +1,78 @@ +# Kaiteki + +[![Build status](https://img.shields.io/github/workflow/status/Kaiteki-Fedi/Kaiteki/Build%20&%20Deploy)](https://github.com/Kaiteki-Fedi/Kaiteki/actions/workflows/ci.yml) [![CodeFactor](https://www.codefactor.io/repository/github/kaiteki-fedi/kaiteki/badge)](https://www.codefactor.io/repository/github/kaiteki-fedi/kaiteki) +[![Translation status](https://wl.craftplacer.moe/widgets/kaiteki/-/app/svg-badge.svg)](https://wl.craftplacer.moe/engage/kaiteki/) + + + +A [快適 (kaiteki)](http://takoboto.jp/?w=1200120) Fediverse client for microblogging instances, made with [Flutter](https://flutter.dev/) and [Dart](https://dart.dev/). + +Currently, Kaiteki is still in a **proof-of-concept/alpha stage**, with simple Mastodon/Pleroma and Misskey support, future backends could follow. See ["What's working, what's missing?"](#whats-working-whats-missing). + +## Screenshots + + + + +
Screenshot of a Misskey feed inside Kaiteki on a phoneScreenshot of an user inside Kaiteki on a tablet
+ +## Platforms & Releases + +If you want to try out Kaiteki, there are automatic builds available for use. + + + + + + + + + + + + + + + + + + + + + + + + +
Web
(recommended)
WindowsLinuxAndroidmacOSiOS
BinariesVisit web versionDownload latest binariesDownload latest binariesDownload latest APKNot supported.
Packages / InstallersNo reliable packaging yet.
Help us!
+ AppImage +

+ Help us package for more platforms! +
+ + +## What's working, what's missing? + +Currently, Kaiteki only allows viewing timelines, making text posts and viewing users. + +Most important API calls for Misskey, Mastodon/Pleroma are already implemented but need a UI implementation. + +Other features that are missing are extensive settings, unit tests, and many other things. **If you'd like to contribute, feel free to do so.** + +## Compiling Kaiteki + +Depending on your platform you might have to take extra steps. +See [this page for steps on compiling for desktop](https://docs.flutter.dev/desktop), and [this page for steps on compiling for web](https://flutter.dev/docs/get-started/web). + +```sh +flutter upgrade # upgrade flutter to its latest version +flutter pub get # get packages + +# run +flutter run + +# ... or compile a release build +flutter build apk --release +flutter build windows --release +flutter build linux --release +flutter build web --release +```