Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace documentation with link to docs project #30

Merged
merged 2 commits into from
Jan 2, 2020
Merged

Replace documentation with link to docs project #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c88fa4
Replace documentation with link to docs project
datenreisender Sep 30, 2019
cc3dc7d
Merge branch 'master' into feature/move-documentation
datenreisender Jan 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 1 addition & 46 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,54 +5,9 @@

*nRF Connect Boilerplate* provides a starting point for developing apps that can be launched by [nRF Connect for Desktop](https://github.com/NordicSemiconductor/pc-nrfconnect-core).
datenreisender marked this conversation as resolved.
Show resolved Hide resolved

## Quick start

1. Create the `.nrfconnect-apps/local` directory if it does not already exist:

* Linux/macOS: `mkdir -p $HOME/.nrfconnect-apps/local`
* Windows: `md "%USERPROFILE%\.nrfconnect-apps\local"`

2. Clone this project under the `local` directory. In a terminal on Linux/macOS or Git bash on Windows:

cd $HOME/.nrfconnect-apps/local
git clone https://github.com/NordicSemiconductor/pc-nrfconnect-boilerplate.git pc-nrfconnect-myapp
cd pc-nrfconnect-myapp
rm -rf .git

Alternatively, if you do not want to use Git, you could download the the current master branch as a [zip file](https://github.com/NordicSemiconductor/pc-nrfconnect-boilerplate/archive/master.zip) and extract it under `.nrfconnect-apps/local/pc-nrfconnect-myapp`.

3. Modify relevant properties in `package.json`. At least consider changing:

* name
* displayName
* version
* author
* license
* repository.url

4. Install dependencies:

npm install

5. Build the project in development mode:

npm run dev

This will keep running and watch for changes (Ctrl+C to stop). Alternatively, to build just once in production mode, run `npm run build`.

6. Run unit tests:

npm run test-watch

This will keep running and watch for changes (Ctrl+C to stop). Alternatively, to run tests just once, run `npm test`.

7. Start nRF Connect and verify that your app appears in the *Launch app* screen. If the build was successful, you should be able to launch it. Chrome Developer Tools can be opened by pressing Ctrl+Alt+I (Windows/Linux) or Cmd+Option+I (macOS).

8. Add your own implementation in `index.jsx` to adjust the behavior of the app.

## Development

See the [app development](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/) pages for details on how to develop apps for the nRF Connect for Desktop framework.
See the [app development](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/) pages for details on how to develop apps for the nRF Connect for Desktop framework and specifically the description [how to create a new app project](https://nordicsemiconductor.github.io/pc-nrfconnect-docs/create_new_app), to understand how you may use this project.

## Feedback

Expand Down