Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zippy committed Jan 30, 2024
1 parent e3b321d commit ce5fb20
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ An attachments hierarchy app for organizing resources in We

1. Install the holochain dev environment: https://developer.holochain.org/docs/install/
2. Clone this repo: `git clone https://github.com/lightningrodlabs/branchy && cd ./branchy`
3. Enter the nix shell: `nix-shell`
3. Enter the nix shell: `nix develop`
4. Install the dependencies with: `npm install`
5. Copy a compatible version of [we](https://github.com/lightningrodlabs/we/releases) to `we_dev/we.AppImage`

## Building the DNA

Expand All @@ -26,10 +27,10 @@ npm run test

## UI

To test out the UI:
To test out the UI make sure you have first copied a version of [we](https://github.com/lightningrodlabs/we/releases) to `we_dev` :

``` bash
npm run start
npm run applet-dev
```

## Package
Expand All @@ -45,7 +46,7 @@ You'll have the `branchy.webhapp` in `workdir`, and it's component `branchy.happ
## License
[![License: CAL 1.0](https://img.shields.io/badge/License-CAL%201.0-blue.svg)](https://github.com/holochain/cryptographic-autonomy-license)

Copyright (C) 2024, Lighning Rod Labs, based on code Copyright (C) Holochain Foundation
Copyright (C) 2024, Lighning Rod Labs, based on [code](https://github.com/holochain/how) Copyright (C) Holochain Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the license
provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful,
Expand Down

0 comments on commit ce5fb20

Please sign in to comment.