youwen5/jankboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(readme): clarify role of splash-screen dir

Browse source
This commit is contained in:
Youwen Wu 2024-03-11 01:12:34 -07:00
parent 4d6df78b56
commit 429ebf9e7f
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -68,8 +68,12 @@ to get the development build up and running.
### Installation steps
1. Clone the repository. The `client` folder contains the vast majority of the
source code for the desktop app.
1. Clone the repository. The `client` directory contains the vast majority of
the source code for the desktop app, while the `splash-screen` directory
contains the source code for the splash screen displayed before the app
loads. You don't have to touch anything in `splash-screen` unless you want to
modify it, in which case check the README in `splash-screen` for more
information.
2. `cd` into the `client` folder. The configuration files and `package.json`,
This is where stuff like `package.json` and configuration files for our
various tooling are housed. The `client/src-tauri` directory contains the