diff --git a/README.md b/README.md index f556119b0..53654caae 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -Byteball is a wallet for storage and transfer of decentralized value. See [byteball.org](https://byteball.org/). +Obyte is a wallet for storage and transfer of decentralized value. See [obyte.org](https://obyte.org/). ## Binary Downloads -[Byteball.org](https://byteball.org/) +[Obyte.org](https://obyte.org/) ## Main Features @@ -15,8 +15,8 @@ Download and install [NW.js v0.14.7 LTS](https://dl.nwjs.io/v0.14.7) and [Node.j Clone the source: ```sh -git clone https://github.com/byteball/byteball.git -cd byteball +git clone https://github.com/byteball/obyte-gui-wallet.git +cd obyte-gui-wallet ``` If you are building for testnet, switch to testnet branch: @@ -31,7 +31,7 @@ npm install -g bower npm install -g grunt-cli ``` -Build Byteball: +Build Obyte: ```sh bower install @@ -40,9 +40,9 @@ grunt ``` If you are on Windows or using NW.js and Node.js versions other than recommended, see [NW.js instructions about building native modules](http://docs.nwjs.io/en/latest/For%20Users/Advanced/Use%20Native%20Node%20Modules/). -After first run, you'll likely encounter runtime error complaining about node_sqlite3.node not being found, copy the file from the neighboring directory to where the program tries to find it, and run again (e.g. from `byteball/node_modules/sqlite3/lib/binding/node-v47-darwin-x64` to `byteball/node_modules/sqlite3/lib/binding/node-webkit-v0.14.7-darwin-x64`). If that didn't work, copy node_sqlite3.node from node_modules folder, which is got installed with installer file from Byteball.org website. +After first run, you'll likely encounter runtime error complaining about node_sqlite3.node not being found, copy the file from the neighboring directory to where the program tries to find it, and run again (e.g. from `obyte-gui-wallet/node_modules/sqlite3/lib/binding/node-v47-darwin-x64` to `obyte-gui-wallet/node_modules/sqlite3/lib/binding/node-webkit-v0.14.7-darwin-x64`). If that didn't work, copy node_sqlite3.node from node_modules folder, which is got installed with installer file from obyte.org website. -Then run Byteball desktop client: +Then run Obyte desktop client: ```sh /path/to/your/nwjs/nwjs . @@ -50,9 +50,9 @@ Then run Byteball desktop client: If you have run `grunt desktop` then there is 0.14.7 NW.js also installed in cache folder. -## Build Byteball App Bundles +## Build Obyte App Bundles -All app bundles will be placed at `../byteballbuilds` dir, so create it first: `mkdir -p ../byteballbuilds` +All app bundles will be placed at `../obytebuilds` dir, so create it first: `mkdir -p ../obytebuilds` ### Android @@ -73,34 +73,34 @@ All app bundles will be placed at `../byteballbuilds` dir, so create it first: ` * In case of ios-deploy missing error: `npm install -g ios-deploy` * In case of `DeviceSupport` missing error, run `cd /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/DeviceSupport/ && sudo ln -s 10.3.1\ \(14E8301\)/ 10.3` * If you encounter 'bitcore' not found after app launch, install it also `npm install bitcore-lib` and remove `../bytebalbuilds/project-IOS` folder completely, then rerun make again. - * On code signing error, open Xcode project `../byteballbuilds/project-IOS/platforms/ios/Byteball.xcodeproj` in Xcode, open project properties, select Byteball target and set your AppleID account as a team. Xcode may also ask you to change bundle identifier to be unique, just append any random string to 'org.byteball.wallet' bundle identifier. + * On code signing error, open Xcode project `../obytebuilds/project-IOS/platforms/ios/Byteball.xcodeproj` in Xcode, open project properties, select Byteball target and set your AppleID account as a team. Xcode may also ask you to change bundle identifier to be unique, just append any random string to 'org.byteball.wallet' bundle identifier. ### macOS - `grunt desktop` -- copy `node_modules` into the app bundle ../byteballbuilds/Byteball/osx64/Byteball.app/Contents/Resources/app.nw, except those that are important only for development (karma, grunt, jasmine) +- copy `node_modules` into the app bundle ../obytebuilds/Obyte/osx64/Obyte.app/Contents/Resources/app.nw, except those that are important only for development (karma, grunt, jasmine) - `grunt dmg` ### Windows - `grunt desktop` -- copy `node_modules` into the app bundle ../byteballbuilds/Byteball/win64, except those that are important only for development (karma, grunt, jasmine) +- copy `node_modules` into the app bundle ../obytebuilds/Obyte/win64, except those that are important only for development (karma, grunt, jasmine) - `grunt inno64` ### Linux - `grunt desktop` -- copy `node_modules` into the app bundle ../byteballbuilds/Byteball/linux64, except those that are important only for development (karma, grunt, jasmine) +- copy `node_modules` into the app bundle ../obytebuilds/Obyte/linux64, except those that are important only for development (karma, grunt, jasmine) - `grunt linux64` -## About Byteball +## About Obyte TBD -## Byteball Backups and Recovery +## Obyte Backups and Recovery -Byteball uses a single extended private key for all wallets, BIP44 is used for wallet address derivation. There is a BIP39 mnemonic for backing up the wallet key, but it is not enough. Private payments and co-signers of multisig wallets are stored only in the app's data directory, which you have to back up manually: +Obyte uses a single extended private key for all wallets, BIP44 is used for wallet address derivation. There is a BIP39 mnemonic for backing up the wallet key, but it is not enough. Private payments and co-signers of multisig wallets are stored only in the app's data directory, which you have to back up manually: * macOS: `~/Library/Application Support/byteball` * Linux: `~/.config/byteball` @@ -109,7 +109,7 @@ Byteball uses a single extended private key for all wallets, BIP44 is used for w ## Translations -Byteball uses standard gettext PO files for translations and [Crowdin](https://crowdin.com/project/byteball) as the front-end tool for translators. To join our team of translators, please create an account at [Crowdin](https://crowdin.com) and translate the Byteball documentation and application text into your native language. +Obyte uses standard gettext PO files for translations and [Crowdin](https://crowdin.com/project/byteball) as the front-end tool for translators. To join our team of translators, please create an account at [Crowdin](https://crowdin.com) and translate the Obyte documentation and application text into your native language. To download and build using the latest translations from Crowdin, please use the following commands: @@ -123,7 +123,7 @@ This will download all partial and complete language translations while also cle ## Support -* [GitHub Issues](https://github.com/byteball/byteball/issues) +* [GitHub Issues](https://github.com/byteball/obyte-gui-wallet/issues) * Open an issue if you are having problems with this project * [Email Support](mailto:byteball@byteball.org)