jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README cleanup

Browse Source 
Summary: Making a few changes to make the information more accurate

Reviewed By: antonk52

Differential Revision: D49152177

fbshipit-source-id: c6dee089a6e30b96c3b8258ef56bebd6eeefaa56
This commit is contained in:
Lorenzo Blasa
2023-09-12 03:55:37 -07:00
committed by Facebook GitHub Bot
parent 423e06e83b
commit b60a8537ff
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
desktop/README.md
View File

@@ -4,13 +4,13 @@ This folder contains everything to run the Flipper 'Desktop', that is, the UI wh
### Packages provided here: ### Packages provided here:
* flipper-common: utilities & types shared between client, server, flipper-plugin * flipper-common: utilities & types shared between client, server, and plugins
* flipper-server-core: all device & client management goes in here. Basically flipper's backend * flipper-server-core: all device & client management goes in here. Basically flipper's backend
* flipper-ui-core: all UI goes in here, as far as it doesn't depend on Electron * flipper-ui-core: all UI goes in here, as far as it doesn't depend on Electron
* flipper-ui-electron: the Electron app, will load server-core and ui-core, and glue them together, providing implementations for some electron * specific stuff like dialgos * app: the Electron app, will load flipper-server-core and flipper-ui-core, and glue them together, providing implementations for some electron specific stuff like dialogs
* flipper-server: A node process hosting flipper-server-core, that can be connected to over websockets. And probably can serve a browser version of the UI as well. * flipper-server: A node process hosting flipper-server-core that can be connected to over websockets. Also, it can serve a browser version of the UI as well.
* flipper-ui-browser: thin wrapper around flipper-ui-core, providing some browser specific behavior / stubs. * flipper-ui-browser: thin wrapper around flipper-ui-core, providing some browser specific behavior / stubs.
* flipper-dump: (might remove later), but want to hack a quick and dirt flipper dump in here, as alternative way to test flipper-server-core. * flipper-dump: (might remove later) as an alternative way to test flipper-server-core.
* flipper-plugin: The flipper SDK used by plugins. Exposes all API's that can be used by plugins * flipper-plugin: The flipper SDK used by plugins. Exposes all API's that can be used by plugins
* pkg: CLI tool to manage building flipper plugins * pkg: CLI tool to manage building flipper plugins
* pkg-lib * pkg-lib
@@ -22,7 +22,7 @@ This folder contains everything to run the Flipper 'Desktop', that is, the UI wh
### Packages overview ### Packages overview
``` ```
flipper-ui-electron: app:
- flipper-server-core (directly embedded) - flipper-server-core (directly embedded)
- flipper-ui-core - flipper-ui-core
- plugins (prebundled) - plugins (prebundled)
@@ -32,7 +32,7 @@ flipper-ui-electron:
flipper-server flipper-server
- flipper-server-core - flipper-server-core
- flipper-ui-browser (served by webserver) - flipper-ui-browser (served by webserver)
- flipper-ui-core (communicates using WebSocket with server-core) - flipper-ui-core (communicates using web sockets with server-core)
- plugins (prebundled) - plugins (prebundled)
- plugins (installable)? - plugins (installable)?